The charge object

Example charge object

{
  "object": "subscription_charge",
  "id": "8144dea5-b2af-4615-b7df-dcfd43edc498",
  "external_id": "charge_1",
  "amount": 1000,
  "currency": "EUR",
  "subscription_id": "d6c50974-70c7-49f8-b50c-797bcefbdeb1",
  "status": "succeeded",
  "metadata": { 
    "invoice_id": "April_2024",
    "invoice_due_date": "2024-04-01T17:28:33.689374Z"
  },
  "store_id": "d41aaaf9-4cbb-4025-b128-da19396cf1dd",
  "created_at": "2024-04-01T17:28:33.689374Z"
}

Attributes

object

string, value is subscription_charge

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

id

string, uuid

Unique identifier of the subscription charge.

external_id

string

The external identifier of the subscription charge specified by the merchant upon creation.

amount

integer

Positive integer representing the amount in cents intended to be collected by this payment.

currency

string

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

subscription_id

string, uuid

The identifier of the subscription associated to this charge.

status

enum, possible values are succeeded,
failed

The status of the payment.

metadata

object

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
Max size: 1KB.

store_id

string

The unique identifier of the store this subscription charge belongs to.

created_at

timestamp

Time at which the object was created. Formatted as a RFC 3339 timestamp.

reverted_at

timestamp

Time at which the charge was reverted. Formatted as a RFC 3339 timestamp.

amount_refunded

integer

Positive integer representing the amount refunded in cents, if any.

refunded_at

timestamp

Time at which the charge was refunded. Formatted as a RFC 3339 timestamp.