UpdateSubscriptionResponseDto
Response returned after a subscription change is initiated.
subscription_changeSubscriptionChangeDtoRequiredA pending or applied change to a subscription.
created_atstringRequired
idFlakeIdRequired
linesSubscriptionChangeLineDto[]RequiredA single line item within a subscription change.
amountSubscriptionChangeLineAmountDtoRequired
→ SubscriptionChangeLineAmountDtoidFlakeIdRequired
is_deletedbooleanRequired
Whether this line is being removed by the change.
presentment_amountSubscriptionChangeLineAmountDtoRequired
→ SubscriptionChangeLineAmountDtopriceintegerRequired
Base price in smallest settlement currency units.
productSubscriptionChangeLineProductDtoRequired
→ SubscriptionChangeLineProductDtoprorated_amountintegerRequired
Prorated charge for this line in smallest settlement currency units.
prorated_presentment_amountintegerRequired
Prorated charge for this line in smallest presentment currency units.
remaining_minutesintegerRequired
Minutes remaining in the billing period at the time of change - used to calculate proration.
tax_inclusivebooleanRequired
Whether tax is included in the base price.
total_minutesintegerRequired
Total minutes in the billing period - used to calculate proration.
subscription_line_idFlakeIdOptional
next_billing_amountSubscriptionChangeAmountDtoRequiredPricing breakdown for a subscription change, in the smallest units of the given currency (e.g. cents).
currencystringRequired
ISO 4217 currency code, in lowercase.
discountintegerRequired
Total discount applied, in smallest currency units.
subtotalintegerRequired
Base amount before discounts or tax, in smallest currency units.
taxintegerRequired
Tax amount, in smallest currency units.
totalintegerRequired
Amount due after discounts and tax, in smallest currency units.
next_billing_presentment_amountSubscriptionChangeAmountDtoRequiredPricing breakdown for a subscription change, in the smallest units of the given currency (e.g. cents).
currencystringRequired
ISO 4217 currency code, in lowercase.
discountintegerRequired
Total discount applied, in smallest currency units.
subtotalintegerRequired
Base amount before discounts or tax, in smallest currency units.
taxintegerRequired
Tax amount, in smallest currency units.
totalintegerRequired
Amount due after discounts and tax, in smallest currency units.
off_sessionbooleanRequired
Whether this change was initiated without active customer interaction.
prorated_amountSubscriptionChangeProratedAmountDtoRequiredThe total prorated charge for a subscription change, expressed in both settlement and presentment currencies.
currencystringRequired
ISO 4217 settlement currency code, in lowercase.
presentment_currencystringRequired
ISO 4217 presentment currency code, in lowercase.
presentment_prorated_amountintegerRequired
Total prorated charge in smallest presentment currency units, including tax.
prorated_amountintegerRequired
Total prorated charge in smallest settlement currency units, including tax.
proration_behaviorenumRequired
Describes how proration is handled when a subscription change is applied.
Possible enum values
invalidimmediateSubscription will be updated instantly, and a proration charge will be applied.
next_billing_periodSubscription will be updated at the end of the billing period, no proration will be applied.
noneNo proration is applied, subscription is updated instantly.
statusenumRequired
Represents the status of a subscription change.
Possible enum values
invalidpending_paymentThe change is pending payment before it can be applied.
pending_renewalThe change will be applied at the next renewal.
appliedThe change has been applied to the subscription.
canceledThe change was canceled and will not be applied.
pending_verificationThe change requires a verification code sent to the customer's e-mail.
subscription_idFlakeIdRequired
applied_atstringOptional
prorated_order_idFlakeIdOptional
pending_paymentCheckoutPaymentInfoDtoOptionalPayment outcome information returned after a subscription change triggers an immediate charge.
declinedbooleanRequired
Indicates whether the payment was declined.
statusstringRequired
Status string from the payment provider.
checkout_urlstringOptional
Checkout URL to redirect to for on-session payments.
decline_messagestringOptional
The customer readable decline reason, if the payment was declined.
Example
{
"subscription_change": {
"created_at": "2024-01-01T00:00:00Z",
"id": "411486491630370816",
"lines": [
{
"amount": {
"currency": "string",
"discount": 0,
"subtotal": 0,
"tax": 0,
"total": 0
},
"id": "411486491630370816",
"is_deleted": true,
"presentment_amount": {
"currency": "string",
"discount": 0,
"subtotal": 0,
"tax": 0,
"total": 0
},
"price": 0,
"product": {
"custom_variables": {},
"id": "411486491630370816",
"name": "string",
"version_id": "411486491630370816",
"image_url": "string",
"selected_gameserver_id": "411486491630370816",
"pricing_region_id": "string"
},
"prorated_amount": 0,
"prorated_presentment_amount": 0,
"remaining_minutes": 0,
"tax_inclusive": true,
"total_minutes": 0,
"subscription_line_id": "411486491630370816"
}
],
"next_billing_amount": {
"currency": "string",
"discount": 0,
"subtotal": 0,
"tax": 0,
"total": 0
},
"next_billing_presentment_amount": {
"currency": "string",
"discount": 0,
"subtotal": 0,
"tax": 0,
"total": 0
},
"off_session": true,
"prorated_amount": {
"currency": "string",
"presentment_currency": "string",
"presentment_prorated_amount": 0,
"prorated_amount": 0
},
"proration_behavior": "invalid",
"status": "invalid",
"subscription_id": "411486491630370816",
"prorated_order_id": "411486491630370816",
"applied_at": "2024-01-01T00:00:00Z"
},
"pending_payment": {
"declined": true,
"status": "string",
"decline_message": "string",
"checkout_url": "string"
}
}