The Credit Balance Transaction object 

Attributes

• idstring

  Unique identifier for the object.

• objectstring

  String representing the object’s type. Objects of the same type share the same value.

• createdtimestamp

  Time at which the object was created. Measured in seconds since the Unix epoch.

• creditnullable object

  Credit details for this credit balance transaction. Only present if type is credit.

  Hide child attributes

  • credit.amountobject

    The amount of credit transaction.

    Hide child attributes

    • credit.amount.monetarynullable object

      The monetary amount.

      Hide child attributes

      • credit.amount.monetary.currencystring

        Three-letter ISO currency code, in lowercase. Must be a supported currency.

      • credit.amount.monetary.valueinteger

        A positive integer representing the amount.

    • credit.amount.typeenum

      The type of this amount. We currently only support monetary billing credits.

      Possible enum values

      monetary The amount is a monetary amount.

  • credit.credits_application_invoice_voidednullable object

    Details of the invoice to which the reinstated credits were originally applied. Only present if type is credits_application_invoice_voided.

    Hide child attributes

    • credit.credits_application_invoice_voided.invoicestringExpandable

      The invoice to which the reinstated billing credits were originally applied.

    • credit.credits_application_invoice_voided.invoice_line_itemstring

      The invoice line item to which the reinstated billing credits were originally applied.

  • credit.typeenum

    The type of credit transaction.

    Possible enum values

    credits_application_invoice_voided Represents the credits reinstated after an invoice to which credits were applied was voided.

    credits_granted Represents the initial funding of credits after a credit grant becomes effective.

• credit_grantstringExpandable

  The credit grant associated with this credit balance transaction.

• debitnullable object

  Debit details for this credit balance transaction. Only present if type is debit.

  Hide child attributes

  • debit.amountobject

    The amount of debit transaction.

    Hide child attributes

    • debit.amount.monetarynullable object

      The monetary amount.

      Hide child attributes

      • debit.amount.monetary.currencystring

        Three-letter ISO currency code, in lowercase. Must be a supported currency.

      • debit.amount.monetary.valueinteger

        A positive integer representing the amount.

    • debit.amount.typeenum

      The type of this amount. We currently only support monetary billing credits.

      Possible enum values

      monetary The amount is a monetary amount.

  • debit.credits_appliednullable object

    Details of how the billing credits were applied to an invoice. Only present if type is credits_applied.

    Hide child attributes

    • debit.credits_applied.invoicestringExpandable

      The invoice to which the billing credits were applied.

    • debit.credits_applied.invoice_line_itemstring

      The invoice line item to which the billing credits were applied.

  • debit.typeenum

    The type of debit transaction.

    Possible enum values

    credits_applied Represents credits that were applied to a line item on an invoice.

    credits_expired Represents credits that were expired due to credit grant being expired.

    credits_voided Represents credits that were voided due to credit grant being voided.

• effective_attimestamp

  The effective time of this credit balance transaction.

• livemodeboolean

  Has the value true if the object exists in live mode or the value false if the object exists in test mode.

• test_clocknullable stringExpandable

  ID of the test clock this credit balance transaction belongs to.

• typenullable enum

  The type of credit balance transaction (credit or debit).

  Possible enum values

  credit A credit transaction.

  debit A debit transaction.