The object is everything inside data. The field names below are relative to it: attributes.paymentNumber is data.attributes.paymentNumber in the response.
Fields
string
required
Subscription payment ID (spm_*).
string
required
Resource type. Always subscriptionPayment.
object
required
The payment’s details.
Hide attributes
integer
required
This payment’s number in its subscription, starting at 1.
integer
required
Amount in cents, tax included.
integer
required
The part of amount that is tax, in cents.
string
required
Currency code. Always USD.
string | null
required
YYYY-MM-DD in UTC. Null when payment 1 succeeded without a trusted agreement date.
string | null
required
RFC 3339 collection-window opening. Null for payment 1, which is paid in checkout.
string | null
required
RFC 3339 collection-window close. An admitted charge may finish afterward. Null for payment 1.
string
required
open while unresolved, including an admitted charge awaiting its outcome; missed when retries ended or its window closed unpaid; paid after a card success or external mark-paid; canceled when collection ended with the subscription. One of: open, missed, paid, canceled. See Statuses.
string | null
required
RFC 3339 time when collection ended unpaid, retained after resolution. A lapsed window uses its close time. Null when no miss occurred or the historical miss time is unknown.
object | null
required
The resolution of a paid payment, otherwise null.
Hide resolution
string
required
How the payment was resolved. One of: cardPayment, markedPaid.
string | null
required
RFC 3339 time Natural recorded the resolution. External collection may have happened earlier. Null for an imported external collection whose recorded time is unknown.
string | null
required
RFC 3339 time collection was canceled, otherwise null.
string
required
RFC 3339 time this payment record was created.
string
required
RFC 3339 time this payment record last changed.
object
required
Objects linked to the payment.
Hide relationships
object
required
The subscription that owes this payment.
Hide subscription
object
required
Related resource identifier.
Hide data
string
required
Resource type. Always subscription.
string
required
Subscription ID (sub_*).
object
required
The successful card charge. Null before card success or when the merchant recorded external collection.
Hide resolvingCardPayment
object | null
required
Related resource identifier.
Hide data
string
required
Resource type. Always cardPayment.
string
required
Card payment ID (cpy_*).
Statuses
Status
Meaning
Can become
open
Due and not paid yet, including while a charge for it awaits its outcome.
paid, missed, canceled
missed
Retries ran out or its window closed unpaid. Natural doesn’t charge it again. The payer can pay it late, or you can mark it paid.
paid
paid
Paid by card, or marked paid. resolution says which.