subscription
Request body
Section titled “Request Body”Sent when a subscription changes state. Subtypes describe changes across the subscription lifecycle:
- STARTING_TRIAL - Trial period starts
- CONVERTION - Trial converts to paid subscription
- RENEWING - Subscription renews (regular charge)
- UNSUBSCRIPTION - User cancels subscription (auto-renewal disabled)
- PLANNING_POSTPONED_SUBSCRIPTION - Subscription with UPCOMING status scheduled to start when delayed_start migration is used
- PAUSING - Subscription paused
- DEFERRING - Next charge date postponed
- RESUMING - Paused subscription resumes
- RECOVERING_AUTORENEW - Auto-renewal restored after failure
- EXPIRATION - Subscription expired
- UNKNOWN - Unknown or unclassified event
- START_GRACE - Grace period starts after failed charge
- START_RETRY - Retry attempts start without grace period
- FINISH_GRACE - Grace period ends
- RECOVERING - Recovered from grace/retry state
object
Show 16 propertiesHide properties
Whether premium features are available
Show 13 propertiesHide properties
Show 4 propertiesHide properties
Premium features included
Show 2 propertiesHide properties
Subscription status
When subscription started. For the first billing cycle, this equals current_period_starts_at.
When current billing period starts. May be in the future because we charge users 2 hours in advance.
When current billing period ends. May be in the past if the last charge failed.
Billing cycle number
Actions you can perform on this subscription
Custom metadata from the initial order
Show 1 propertyHide property
Discounts applied to this subscription
Show 6 propertiesHide properties
Show 1 propertyHide property
When the subscription last changed
Show 3 propertiesHide properties
Previous email addresses associated with this user
Show 16 propertiesHide properties
Show 1 propertyHide property
Adyen store that processed the payment, as sent to Primer in ff_adyen_shop_id_<region>. Adyen only reports it in its notification, so it appears once that notification is processed.
The processor’s own ID for the sale that took the payment, as the processor reported it, for example the PaymentIntent ID (pi_...) for Stripe. Never the ID of a refund or a declined attempt. Null while the order isn’t paid (declined, cancelled, or a card check for a trial or card update) or when the processor reported none.
Details of a one-click payment: how it was sent, which saved method was charged, and its 3DS outcome.
Show 7 propertiesHide properties
How the payment was sent to the PSP: cit (customer-initiated, the bank can ask for 3DS) or mit (merchant-initiated).
wallet_reauth: the customer confirmed the upsell in the Apple Pay or Google Pay sheet, and it was charged with that fresh wallet token (customer-initiated). Null for a one-click payment charged on the saved method.
The PSP’s raw 3DS reason code for the outcome, for example CARD_AUTHENTICATION_FAILED, TRANSACTION_TIMED_OUT_AT_THE_ACS, or NOT_SUPPORTED_BY_ISSUER. Null when the PSP reported none.
Card brand of the charged method in upper case, for example VISA or MASTERCARD. Null when unknown and for PSPs other than Primer.
Whether 3DS was required for this payment: true unless threeds_outcome is none or skipped. Null when threeds_outcome is null.