Skip to main content

Interface: Charge

Properties​

address_id​

address_id: number

The ID of the shipping Address tied to the Charge.

analytics_data​

analytics_data: AnalyticsData

An object containing analytics data associated with the Charge.

billing_address​

billing_address: AssociatedAddress

All the billing information related to the charge.

charge_attempts?​

optional charge_attempts?: number

Shows how many times an attempt to charge was placed.

client_details​

client_details: object

Details of the access method used by the purchaser.

browser_ip​

browser_ip: string | null

The IP address of the buyer as detected in Checkout.

user_agent​

user_agent: string | null

The user agent detected during Checkout.

created_at​

created_at: string

The date and time when the transaction was created.

currency​

currency: string

The code of the currency for this Charge, such as USD.

customer​

customer: object

An object containing Customer information associated with this Charge.

email​

email: string

The user email.

external_customer_id​

external_customer_id: ExternalId

An object containing customer information associated with this charge.

hash​

hash: string

The hash of the Customer associated with the Charge.

id​

id: number

The ID of the associated customer record.

discounts​

discounts: Discount[]

An array of Discounts associated with the Charge.

error?​

optional error?: string | null

Error reason as sentence text (typically returned direct from the payment processor). e.g. "error": "Customer needs to update credit card"

error_type?​

optional error_type?: string | null

Structured reason why the charge failed such as CUSTOMER_NEEDS_TO_UPDATE_CARD.

external_order_id​

external_order_id: ExternalId

An object containing the associated external order ID.

external_transaction_id​

external_transaction_id: ExternalTransactionId

An object containing the associated external transaction ID.

external_variant_id_not_found?​

optional external_variant_id_not_found?: boolean

Indicates if Recharge was able to find the external_variant_id from the Charge.

has_uncommitted_changes?​

optional has_uncommitted_changes?: boolean

Specifies whether the Charge is scheduled for a regeneration (if the Subscription related to the charge was updated in the last 5 seconds using commit=false).

id​

id: number

The unique numeric identifier for the Charge.

include?​

optional include?: object

Additional information as requested

customer?​

optional customer?: Customer

metafields?​

optional metafields?: Metafield[]

payment_methods?​

optional payment_methods?: PaymentMethod[]

subscriptions?​

optional subscriptions?: Subscription[]

line_items​

line_items: LineItem[]

A list of line_item objects, each containing information about a distinct purchase item.

merged_at?​

optional merged_at?: string | null

The date and time when the Charge was merged (if applicable).

note​

note: string | null

Notes associated with the Charge.

order_attributes​

order_attributes: Property[]

An array of name-value pairs of order attributes on the Charge.

orders_count​

orders_count: number

The number of Orders generated from this Charge (>1 for prepaid Subscriptions).

original_scheduled_at?​

optional original_scheduled_at?: string | null

The originally scheduled date for the Charge, before any rescheduling.

payment_processor​

payment_processor: string

The payment processor used for this Charge.

processed_at​

processed_at: string

The date and time when the transaction was processed.

retry_date?​

optional retry_date?: string | null

The date when the next attempt will be placed.

scheduled_at​

scheduled_at: string

The date time of when the Charge is/was scheduled to process.

shipping_address​

shipping_address: AssociatedAddress

The shipping Address of the Charge.

shipping_lines​

shipping_lines: ShippingLine[]

An array of shipping lines associated with the Charge.

status​

status: ChargeStatus

The status of the Charge.

subtotal_price​

subtotal_price: string

The combined price of all line_items without taxes and shipping.

tags​

tags: string | null

A comma-separated list of tags on the Charge.

tax_lines​

tax_lines: TaxLine[]

An array of tax lines that apply to the Charge.

taxable​

taxable: boolean

A boolean indicator of the taxability of the Charge.

taxes_included​

taxes_included: boolean

A boolean indicating if the total price includes taxes.

total_discounts​

total_discounts: string

The sum of the Discounts applied to the Charge.

total_duties​

total_duties: string

The total duties associated with the Charge.

total_line_items_price​

total_line_items_price: string

The total price of all line items of the Charge.

total_price​

total_price: string

The sum of all the prices of all the items in the Charge, taxes and discounts included (must be positive).

total_refunds​

total_refunds: string

The sum of all refunds that were applied to the Charge.

total_tax​

total_tax: string

The total tax due associated with the Charge.

total_weight_grams​

total_weight_grams: number

The total weight of the Charge’s line items in grams.

type​

type: "checkout" | "recurring"

An indicator of the Charge’s type, either checkout or recurring.

updated_at​

updated_at: string

The date time at which the Charge was most recently updated.