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?
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.
Type declaration
browser_ip
browser_ip:
string
The IP address of the buyer as detected in Checkout.
user_agent
user_agent:
string
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.
Type declaration
email
email:
string
The user email.
external_customer_id
external_customer_id:
string
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?
error?:
string
Error reason as sentence text (typically returned direct from the payment processor). e.g. "error": "Customer needs to update credit card"
error_type?
error_type?:
string
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?
external_variant_id_not_found?:
boolean
Indicates if Recharge was able to find the external_variant_id from the Charge.
has_uncommited_changes?
has_uncommited_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?
include?:
Object
Additional information as requested
Type declaration
customer?
customer?:
Customer
metafields?
metafields?:
Metafield
[]
payment_methods?
payment_methods?:
PaymentMethod
[]
line_items
line_items:
LineItem
[]
A list of line_item objects, each containing information about a distinct purchase item.
note
note:
string
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).
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?
retry_date?:
string
The date when the next attempt will be placed.