Path parameters

• account_id string Required

  Account ID

Responses

• 200

  Charge Created

  Hide response attributes Show response attributes object

  • account_id string Required

    The account associated with the line item

  • line_item_id string Required

    The ID associated with the line item

  • effective_at string(date-time)

    The Date-Time that this line item became/becomes active

  • created_at string(date-time)

    The Date-Time which the line item was created.

  • product_id string Required

    the Product ID of the account

  • line_item_summary object
    Hide line_item_summary attributes Show line_item_summary attributes object

    • original_amount_cents integer

      The originating amount of money (in cents) relating to this line item.

    • balance_cents integer

      The current balance of the line item, which accounts for interest accrued per the product's interest policy and the account's interest rate attribute.

    • principal_cents integer

      The principal balance of the line item.

    • interest_balance_cents integer

      The current interest balance of the line item.

    • am_interest_balance_cents integer

      The current AM interest balance of the line item. Canopy tracks interest during an amortization period separately from deferred interest accrued during a revolving period.

    • deferred_interest_balance_cents integer

      The current deferred interest balance of the line item.

    • am_deferred_interest_balance_cents integer

      The current AM deferred interest balance of the line item. Canopy tracks deferred interest during an amortization period separately from deferred interest accrued during a revolving period.

    • total_interest_paid_to_date_cents integer

      The sum (in cents) of all payments towards interest charges, if any, applied to this line item to date

  • merchant_data object | null

    Merchant information if applicable.

    Hide merchant_data attributes Show merchant_data attributes object | null

    • name string
    • id string
    • mcc_code number
    • phone_number string
  • issuer_processor_details object | null
    Hide issuer_processor_details attribute Show issuer_processor_details attribute object | null

    • lithic object
      Hide lithic attributes Show lithic attributes object

      • last_four string | null

        Last four digits of the card against which the spend was made.

      • transaction_token string(uuid) | null

        The external unique identifier of the transaction.

      • card_token string(uuid) | null

        The external unique identifier of the card related to this line item.

  • external_fields array[object] | null

    An array of static references to fields in a third party system.

    Not more than 1000 elements.

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

    • key string

      Key - i.e. Name of the External Party

    • value string

      Value - i.e. External Account ID

  • line_item_overview object
    Hide line_item_overview attributes Show line_item_overview attributes object

    • line_item_status string

      The status of a line item.

      Values are VALID, INVALID, OFFSET, PENDING, AUTHORIZED, DECLINED, VOID, or POSTED. Default value is VALID.

    • line_item_type string Required

      The line item type CHARGE

      Default value is CHARGE.

    • description string | null

      A description of this particular line item if any. More common for adjustments.

  • Additional properties are allowed
• 401

  Unauthorized.

• 403

  Forbidden.

• 422

  Invalid input

• 429

  Too many requests.

• default

  Unexpected Error.