Path parameters

• account_id string Required

  Account ID

Responses

• 429

  Too many requests.

• 200

  Array of all temporary promos for an account

  Hide response attributes Show response attributes object

  • results array[object] | null

    An array of information for all temp promos for the account.

    Not more than 1000 elements.

    Hide results attributes Show results attributes array[object] | null

    • temp_promo_id string

      This is generated by Canopy. A unique ID for the temporary promo.

    • temp_promo_inclusive_start string(date-time)

      The Date-Time as of which this temporary promo starts for the account.

    • temp_promo_exclusive_end string(date-time)

      The Date-Time as of which this temporary promo ends for the account.

    • interest_rate_percent number

      The percentage interest applied to the account during the temporary promotional period (i.e. 6.2%).

      Default value is 0.

    • interest_rate_percent_prev number

      The previous percentage interest applied to the account, to which the account will revert after the temporary promotion.

      Default value is 0.

    • late_fee_cents integer

      The late fee to be charged for late payments during the promotional period.

      Default value is 0.

    • late_fee_cents_prev integer

      The previous late fee to be charged for late payments, to which the account will revert after the temporary promotion.

      Default value is 0.

    • Additional properties are NOT allowed
  • Additional properties are allowed
• 401

  Unauthorized.

• 403

  Forbidden.

• 404

  Account not found

• default

  Unexpected Error.