post https://api.fastspring.com/subscriptions/estimate
Use this endpoint to preview the estimated charges, credits, or refunds for a subscription before making any changes.
Input
Send the subscriptionID along with any other product attributes you want to change or override. This endpoint returns a prorated estimate for only one subscription per request. Construct your request similarly to the Subscription Change API, but without the square brackets [] that indicate an array of subscriptions.
Response Objects
The response includes three main objects:
| Object | Description |
|---|---|
amountDue | Total charge, next recurring charge date, and the amount of the next recurring charge. |
currentPlan | Details of the current subscription:
|
proposedPlan | Similar to currentPlan, but for the proposed subscription:
|
Examples
Use Case 1: Plan Change (Upgrade)
This example produces an estimate for changing a monthly subscription from Basic at $200 to Premium for $350.
{
"subscription": "mG7NGFRMQXSz0ud-Ybp7gA",
"product":"premium"
}
{
"subscription": "mG7NGFRMQXSz0ud-Ybp7gA",
"currency": "USD",
"timezone": "UTC",
"periodStartDate": 1679961600000,
"periodStartDateDisplay": "3/28/23",
"periodStartDateDisplayISO8601": "2023-03-28",
"periodEndDate": 1682553600000,
"periodEndDateDisplay": "4/27/23",
"periodEndDateDisplayISO8601": "2023-04-27",
"currentPlan": {
"display": "Basic",
"product": "basic",
"billingFrequency": "1 month",
"price": 200.00,
"priceDisplay": "$200.00",
"discount": 0.00,
"discountDisplay": "$0.00",
"quantity": 1,
"subtotal": 200.00,
"subtotalDisplay": "$200.00",
"tax": 0.00,
"taxDisplay": "$0.00",
"total": 200.00,
"totalDisplay": "$200.00",
"taxPercent": 7.75,
"taxPercentDisplay": "7.75%",
"periodStartDate": 1679961600000,
"periodStartDateDisplay": "3/28/23",
"periodStartDateDisplayISO8601": "2023-03-28",
"periodEndDate": 1679961600000,
"periodEndDateDisplay": "3/28/23",
"periodEndDateDisplayISO8601": "2023-03-28",
"proratedItemCharge": 300.00,
"proratedItemChargeDisplay": "$300.00",
"proratedItemCredit": 200.00,
"proratedItemCreditDisplay": "$200.00",
"proratedItemSubtotal": 100.00,
"proratedItemSubtotalDisplay": "$100.00",
"proratedItemTax": 0.00,
"proratedItemTaxDisplay": "$0.00",
"proratedItemTotal": 100.00,
"proratedItemTotalDisplay": "$100.00",
"addons": [],
"subscriptionSubtotal": 200.00,
"subscriptionSubtotalDisplay": "$200.00",
"subscriptionTax": 0.00,
"subscriptionTaxDisplay": "$0.00",
"subscriptionTotal": 200.00,
"subscriptionTotalDisplay": "$200.00",
"subscriptionProratedCredit": 200.00,
"subscriptionProratedCreditDisplay": "$200.00"
},
"proposedPlan": {
"display": "Premium",
"product": "premium",
"billingFrequency": "1 month",
"price": 300.00,
"priceDisplay": "$300.00",
"discount": 0.00,
"discountDisplay": "$0.00",
"quantity": 1,
"subtotal": 300.00,
"subtotalDisplay": "$300.00",
"tax": 0.00,
"taxDisplay": "$0.00",
"total": 300.00,
"totalDisplay": "$300.00",
"taxPercent": 7.75,
"taxPercentDisplay": "7.75%",
"periodStartDate": 1679961600000,
"periodStartDateDisplay": "3/28/23",
"periodStartDateDisplayISO8601": "2023-03-28",
"periodEndDate": 1682553600000,
"periodEndDateDisplay": "4/27/23",
"periodEndDateDisplayISO8601": "2023-04-27",
"proratedItemCharge": 300.00,
"proratedItemChargeDisplay": "$300.00",
"proratedItemCredit": 200.00,
"proratedItemCreditDisplay": "$200.00",
"proratedItemSubtotal": 100.00,
"proratedItemSubtotalDisplay": "$100.00",
"proratedItemTax": 0.00,
"proratedItemTaxDisplay": "$0.00",
"proratedItemTotal": 100.00,
"proratedItemTotalDisplay": "$100.00",
"addons": [],
"subscriptionSubtotal": 300.00,
"subscriptionSubtotalDisplay": "$300.00",
"subscriptionTax": 0.00,
"subscriptionTaxDisplay": "$0.00",
"subscriptionTotal": 300.00,
"subscriptionTotalDisplay": "$300.00",
"subscriptionProratedCharge": 300.00,
"subscriptionProratedChargeDisplay": "$300.00"
},
"amountDue": {
"prorationSubtotal": 100.00,
"prorationSubtotalDisplay": "$100.00",
"prorationTax": 0.00,
"prorationTaxDisplay": "$0.00",
"totalAmountDue": 100.00,
"totalAmountDueDisplay": "$100.00",
"nextChargeDate": 1682640000000,
"nextChargeDateDisplay": "4/28/23",
"nextChargeDateDisplayISO8601": "2023-04-28",
"nextChargeAmount": 300.00,
"nextChargeAmountDisplay": "$300.00"
}
}
Use Case 2: Plan Change (Downgrade)
This example produces an estimate for changing a monthly subscription from Premium at $350 to Basic at $200.
{
"subscription": "7oSTq-tZS9S0LoOpiPQL5w",
"product":"basic"
}
{
"subscription": "7oSTq-tZS9S0LoOpiPQL5w",
"currency": "USD",
"timezone": "UTC",
"periodStartDate": 1679961600000,
"periodStartDateDisplay": "3/28/23",
"periodStartDateDisplayISO8601": "2023-03-28",
"periodEndDate": 1682553600000,
"periodEndDateDisplay": "4/27/23",
"periodEndDateDisplayISO8601": "2023-04-27",
"currentPlan": {
"display": "Premium",
"product": "premium",
"billingFrequency": "1 month",
"price": 300.00,
"priceDisplay": "$300.00",
"discount": 0.00,
"discountDisplay": "$0.00",
"quantity": 1,
"subtotal": 300.00,
"subtotalDisplay": "$300.00",
"tax": 0.00,
"taxDisplay": "$0.00",
"total": 300.00,
"totalDisplay": "$300.00",
"taxPercent": 7.75,
"taxPercentDisplay": "7.75%",
"periodStartDate": 1679961600000,
"periodStartDateDisplay": "3/28/23",
"periodStartDateDisplayISO8601": "2023-03-28",
"periodEndDate": 1679961600000,
"periodEndDateDisplay": "3/28/23",
"periodEndDateDisplayISO8601": "2023-03-28",
"proratedItemCharge": 200.00,
"proratedItemChargeDisplay": "$200.00",
"proratedItemCredit": 300.00,
"proratedItemCreditDisplay": "$300.00",
"proratedItemSubtotal": -100.00,
"proratedItemSubtotalDisplay": "-$100.00",
"proratedItemTax": 0.00,
"proratedItemTaxDisplay": "$0.00",
"proratedItemTotal": -100.00,
"proratedItemTotalDisplay": "-$100.00",
"addons": [],
"subscriptionSubtotal": 300.00,
"subscriptionSubtotalDisplay": "$300.00",
"subscriptionTax": 0.00,
"subscriptionTaxDisplay": "$0.00",
"subscriptionTotal": 300.00,
"subscriptionTotalDisplay": "$300.00",
"subscriptionProratedCredit": 300.00,
"subscriptionProratedCreditDisplay": "$300.00"
},
"proposedPlan": {
"display": "Basic",
"product": "basic",
"billingFrequency": "1 month",
"price": 200.00,
"priceDisplay": "$200.00",
"discount": 0.00,
"discountDisplay": "$0.00",
"quantity": 1,
"subtotal": 200.00,
"subtotalDisplay": "$200.00",
"tax": 0.00,
"taxDisplay": "$0.00",
"total": 200.00,
"totalDisplay": "$200.00",
"taxPercent": 7.75,
"taxPercentDisplay": "7.75%",
"periodStartDate": 1679961600000,
"periodStartDateDisplay": "3/28/23",
"periodStartDateDisplayISO8601": "2023-03-28",
"periodEndDate": 1682553600000,
"periodEndDateDisplay": "4/27/23",
"periodEndDateDisplayISO8601": "2023-04-27",
"proratedItemCharge": 200.00,
"proratedItemChargeDisplay": "$200.00",
"proratedItemCredit": 300.00,
"proratedItemCreditDisplay": "$300.00",
"proratedItemSubtotal": -100.00,
"proratedItemSubtotalDisplay": "-$100.00",
"proratedItemTax": 0.00,
"proratedItemTaxDisplay": "$0.00",
"proratedItemTotal": -100.00,
"proratedItemTotalDisplay": "-$100.00",
"addons": [],
"subscriptionSubtotal": 200.00,
"subscriptionSubtotalDisplay": "$200.00",
"subscriptionTax": 0.00,
"subscriptionTaxDisplay": "$0.00",
"subscriptionTotal": 200.00,
"subscriptionTotalDisplay": "$200.00",
"subscriptionProratedCharge": 200.00,
"subscriptionProratedChargeDisplay": "$200.00"
},
"amountDue": {
"prorationSubtotal": -100.00,
"prorationSubtotalDisplay": "-$100.00",
"prorationTax": 0.00,
"prorationTaxDisplay": "$0.00",
"totalAmountDue": 0.00,
"totalAmountDueDisplay": "$0.00",
"nextChargeDate": 1682640000000,
"nextChargeDateDisplay": "4/28/23",
"nextChargeDateDisplayISO8601": "2023-04-28",
"nextChargeAmount": 200.00,
"nextChargeAmountDisplay": "$200.00"
}
}
Use Case 3: Add-on Quantity Change
This example produces an estimate for increasing the quantity of an add-on:
- The current subscription includes a weekly subscription for Megazines at $100.
- The new subscription would include add-ons for All Access to Live Radio, Podcasts, and Narrated Articles at $100.
- The proposed change increases the add-on quantity from 1 to 4.
{
"subscription": "a2usH67SSDGfLC16z1oKNw",
"addons": [
{
"product": "all-access+radio+podcasts+articles",
"quantity": 4
}
]
}
{
"subscription": "a2usH67SSDGfLC16z1oKNw",
"currency": "USD",
"timezone": "UTC",
"periodStartDate": 1679961600000,
"periodStartDateDisplay": "3/28/23",
"periodStartDateDisplayISO8601": "2023-03-28",
"periodEndDate": 1680480000000,
"periodEndDateDisplay": "4/3/23",
"periodEndDateDisplayISO8601": "2023-04-03",
"currentPlan": {
"display": "Megazines",
"product": "megazines",
"billingFrequency": "1 week",
"price": 100.00,
"priceDisplay": "$100.00",
"discount": 0.00,
"discountDisplay": "$0.00",
"quantity": 1,
"subtotal": 100.00,
"subtotalDisplay": "$100.00",
"tax": 0.00,
"taxDisplay": "$0.00",
"total": 100.00,
"totalDisplay": "$100.00",
"taxPercent": 7.75,
"taxPercentDisplay": "7.75%",
"periodStartDate": 1679961600000,
"periodStartDateDisplay": "3/28/23",
"periodStartDateDisplayISO8601": "2023-03-28",
"periodEndDate": 1680048000000,
"periodEndDateDisplay": "3/29/23",
"periodEndDateDisplayISO8601": "2023-03-29",
"proratedItemCharge": 85.71,
"proratedItemChargeDisplay": "$85.71",
"proratedItemCredit": 85.71,
"proratedItemCreditDisplay": "$85.71",
"proratedItemSubtotal": 0.00,
"proratedItemSubtotalDisplay": "$0.00",
"proratedItemTax": 0.00,
"proratedItemTaxDisplay": "$0.00",
"proratedItemTotal": 0.00,
"proratedItemTotalDisplay": "$0.00",
"addons": [
{
"display": "All Access to Live Radio, Podcasts and Narrated Articles",
"product": "all-access+radio+podcasts+articles",
"price": 100.00,
"priceDisplay": "$100.00",
"discount": 0.00,
"discountDisplay": "$0.00",
"quantity": 1,
"subtotal": 100.00,
"subtotalDisplay": "$100.00",
"tax": 0.00,
"taxDisplay": "$0.00",
"total": 100.00,
"totalDisplay": "$100.00",
"taxPercent": 7.75,
"taxPercentDisplay": "7.75%",
"proratedItemCharge": 342.86,
"proratedItemChargeDisplay": "$342.86",
"proratedItemCredit": 85.71,
"proratedItemCreditDisplay": "$85.71",
"proratedItemSubtotal": 257.14,
"proratedItemSubtotalDisplay": "$257.14",
"proratedItemTax": 0.00,
"proratedItemTaxDisplay": "$0.00",
"proratedItemTotal": 257.14,
"proratedItemTotalDisplay": "$257.14"
}
],
"subscriptionSubtotal": 200.00,
"subscriptionSubtotalDisplay": "$200.00",
"subscriptionTax": 0.00,
"subscriptionTaxDisplay": "$0.00",
"subscriptionTotal": 200.00,
"subscriptionTotalDisplay": "$200.00",
"subscriptionProratedCredit": 171.43,
"subscriptionProratedCreditDisplay": "$171.43"
},
"proposedPlan": {
"display": "Megazines",
"product": "megazines",
"billingFrequency": "1 week",
"price": 100.00,
"priceDisplay": "$100.00",
"discount": 0.00,
"discountDisplay": "$0.00",
"quantity": 1,
"subtotal": 100.00,
"subtotalDisplay": "$100.00",
"tax": 0.00,
"taxDisplay": "$0.00",
"total": 100.00,
"totalDisplay": "$100.00",
"taxPercent": 7.75,
"taxPercentDisplay": "7.75%",
"periodStartDate": 1680048000000,
"periodStartDateDisplay": "3/29/23",
"periodStartDateDisplayISO8601": "2023-03-29",
"periodEndDate": 1680480000000,
"periodEndDateDisplay": "4/3/23",
"periodEndDateDisplayISO8601": "2023-04-03",
"proratedItemCharge": 85.71,
"proratedItemChargeDisplay": "$85.71",
"proratedItemCredit": 85.71,
"proratedItemCreditDisplay": "$85.71",
"proratedItemSubtotal": 0.00,
"proratedItemSubtotalDisplay": "$0.00",
"proratedItemTax": 0.00,
"proratedItemTaxDisplay": "$0.00",
"proratedItemTotal": 0.00,
"proratedItemTotalDisplay": "$0.00",
"addons": [
{
"display": "All Access to Live Radio, Podcasts and Narrated Articles",
"product": "all-access+radio+podcasts+articles",
"price": 100.00,
"priceDisplay": "$100.00",
"discount": 0.00,
"discountDisplay": "$0.00",
"quantity": 4,
"subtotal": 400.00,
"subtotalDisplay": "$400.00",
"tax": 0.00,
"taxDisplay": "$0.00",
"total": 400.00,
"totalDisplay": "$400.00",
"taxPercent": 7.75,
"taxPercentDisplay": "7.75%",
"proratedItemCharge": 342.86,
"proratedItemChargeDisplay": "$342.86",
"proratedItemCredit": 85.71,
"proratedItemCreditDisplay": "$85.71",
"proratedItemSubtotal": 257.14,
"proratedItemSubtotalDisplay": "$257.14",
"proratedItemTax": 0.00,
"proratedItemTaxDisplay": "$0.00",
"proratedItemTotal": 257.14,
"proratedItemTotalDisplay": "$257.14"
}
],
"subscriptionSubtotal": 500.00,
"subscriptionSubtotalDisplay": "$500.00",
"subscriptionTax": 0.00,
"subscriptionTaxDisplay": "$0.00",
"subscriptionTotal": 500.00,
"subscriptionTotalDisplay": "$500.00",
"subscriptionProratedCharge": 428.57,
"subscriptionProratedChargeDisplay": "$428.57"
},
"amountDue": {
"prorationSubtotal": 257.14,
"prorationSubtotalDisplay": "$257.14",
"prorationTax": 0.00,
"prorationTaxDisplay": "$0.00",
"totalAmountDue": 257.14,
"totalAmountDueDisplay": "$257.14",
"nextChargeDate": 1680566400000,
"nextChargeDateDisplay": "4/4/23",
"nextChargeDateDisplayISO8601": "2023-04-04",
"nextChargeAmount": 500.00,
"nextChargeAmountDisplay": "$500.00"
}
}
Use Case 4: Base Plan Quantity and Price Changes, Add-on Quantity Changes, Discount Added
This example produces an estimate for multiple changes to a subscription:
-
The current subscription includes:
- An Enterprise Subscription Plan with a quantity of 1 for $750/month.
- An Enterprise-level Gold add-on for $250/month.
- Items are taxed at 7%.
-
The proposed changes:
- Base plan quantity would change from 1 to 3.
- Base plan price would change from $750 to $700.
- Gold add-on quantity would change from 1 to 5.
- Gold add-on price would change from $250 to $275.
- Platinum add-on quantity would change from 0 to 5 (new add-on).
- A Platinum add-on 10% discount would be added.
{
"subscription": "A1TMBQB_Q9-0N-ozN-DR1w",
"quantity": 3,
"pricing": {
"price": {
"USD": 700
}
},
"addons": [
{
"product": "widget-enterprise-gold-addon",
"quantity": 5,
"pricing": {
"price": {
"USD": 275
}
}
},
{
"product": "widget-enterprise-platinum-addon",
"quantity": 5,
"pricing": {
"discount": {
"type":"percent",
"percentage": 10
}
}
}
]
}
{
"subscription": "A1TMBQB_Q9-0N-ozN-DR1w",
"currency": "USD",
"timezone": "UTC",
"periodStartDate": 1681344000000,
"periodStartDateDisplay": "4/13/23",
"periodStartDateDisplayISO8601": "2023-04-13",
"periodEndDate": 1683849600000,
"periodEndDateDisplay": "5/12/23",
"periodEndDateDisplayISO8601": "2023-05-12",
"isProratable": true,
"prorationStatus": "Available",
"currentPlan": {
"display": "Widget Enterprise Subscription",
"product": "widget-enterprise-subscription",
"billingFrequency": "1 month",
"price": 750.00,
"priceDisplay": "$750.00",
"discount": 0.00,
"discountDisplay": "$0.00",
"quantity": 1,
"subtotal": 750.00,
"subtotalDisplay": "$750.00",
"tax": 52.51,
"taxDisplay": "$52.51",
"total": 802.51,
"totalDisplay": "$802.51",
"taxPercent": 7.00,
"taxPercentDisplay": "7%",
"periodStartDate": 1681344000000,
"periodStartDateDisplay": "4/13/23",
"periodStartDateDisplayISO8601": "2023-04-13",
"periodEndDate": 1681344000000,
"periodEndDateDisplay": "4/13/23",
"periodEndDateDisplayISO8601": "2023-04-13",
"proratedItemCharge": 2100.00,
"proratedItemChargeDisplay": "$2,100.00",
"proratedItemCredit": 750.00,
"proratedItemCreditDisplay": "$750.00",
"proratedItemSubtotal": 1350.00,
"proratedItemSubtotalDisplay": "$1,350.00",
"proratedItemTax": 94.51,
"proratedItemTaxDisplay": "$94.51",
"proratedItemTotal": 1444.51,
"proratedItemTotalDisplay": "$1,444.51",
"addons": [
{
"display": "Widget Enterprise Gold Addon",
"product": "widget-enterprise-gold-addon",
"price": 250.00,
"priceDisplay": "$250.00",
"discount": 0.00,
"discountDisplay": "$0.00",
"quantity": 1,
"subtotal": 250.00,
"subtotalDisplay": "$250.00",
"tax": 17.51,
"taxDisplay": "$17.51",
"total": 267.51,
"totalDisplay": "$267.51",
"taxPercent": 7.00,
"taxPercentDisplay": "7%",
"proratedItemCharge": 1168.75,
"proratedItemChargeDisplay": "$1,168.75",
"proratedItemCredit": 250.00,
"proratedItemCreditDisplay": "$250.00",
"proratedItemSubtotal": 918.75,
"proratedItemSubtotalDisplay": "$918.75",
"proratedItemTax": 64.31,
"proratedItemTaxDisplay": "$64.31",
"proratedItemTotal": 983.06,
"proratedItemTotalDisplay": "$983.06"
}
],
"subscriptionSubtotal": 1000.00,
"subscriptionSubtotalDisplay": "$1,000.00",
"subscriptionTax": 70.02,
"subscriptionTaxDisplay": "$70.02",
"subscriptionTotal": 1070.02,
"subscriptionTotalDisplay": "$1,070.02",
"subscriptionProratedCredit": 1000.00,
"subscriptionProratedCreditDisplay": "$1,000.00"
},
"proposedPlan": {
"display": "Widget Enterprise Subscription",
"product": "widget-enterprise-subscription",
"billingFrequency": "1 month",
"price": 700.00,
"priceDisplay": "$700.00",
"discount": 0.00,
"discountDisplay": "$0.00",
"quantity": 3,
"subtotal": 2100.00,
"subtotalDisplay": "$2,100.00",
"tax": 147.00,
"taxDisplay": "$147.00",
"total": 2247.00,
"totalDisplay": "$2,247.00",
"taxPercent": 7.00,
"taxPercentDisplay": "7%",
"periodStartDate": 1681344000000,
"periodStartDateDisplay": "4/13/23",
"periodStartDateDisplayISO8601": "2023-04-13",
"periodEndDate": 1683849600000,
"periodEndDateDisplay": "5/12/23",
"periodEndDateDisplayISO8601": "2023-05-12",
"proratedItemCharge": 2100.00,
"proratedItemChargeDisplay": "$2,100.00",
"proratedItemCredit": 750.00,
"proratedItemCreditDisplay": "$750.00",
"proratedItemSubtotal": 1350.00,
"proratedItemSubtotalDisplay": "$1,350.00",
"proratedItemTax": 94.51,
"proratedItemTaxDisplay": "$94.51",
"proratedItemTotal": 1444.51,
"proratedItemTotalDisplay": "$1,444.51",
"addons": [
{
"display": "Widget Enterprise Gold Addon",
"product": "widget-enterprise-gold-addon",
"price": 275.00,
"priceDisplay": "$275.00",
"discount": 41.25,
"discountDisplay": "$41.25",
"quantity": 5,
"subtotal": 1168.75,
"subtotalDisplay": "$1,168.75",
"tax": 81.82,
"taxDisplay": "$81.82",
"total": 1250.57,
"totalDisplay": "$1,250.57",
"taxPercent": 7.00,
"taxPercentDisplay": "7%",
"proratedItemCharge": 1168.75,
"proratedItemChargeDisplay": "$1,168.75",
"proratedItemCredit": 250.00,
"proratedItemCreditDisplay": "$250.00",
"proratedItemSubtotal": 918.75,
"proratedItemSubtotalDisplay": "$918.75",
"proratedItemTax": 64.31,
"proratedItemTaxDisplay": "$64.31",
"proratedItemTotal": 983.06,
"proratedItemTotalDisplay": "$983.06"
},
{
"display": "Widget Enterprise Platinum Addon",
"product": "widget-enterprise-platinum-addon",
"price": 500.00,
"priceDisplay": "$500.00",
"discount": 50.00,
"discountDisplay": "$50.00",
"quantity": 5,
"subtotal": 2250.00,
"subtotalDisplay": "$2,250.00",
"tax": 157.51,
"taxDisplay": "$157.51",
"total": 2407.51,
"totalDisplay": "$2,407.51",
"taxPercent": 7.00,
"taxPercentDisplay": "7%",
"proratedItemCharge": 2250.00,
"proratedItemChargeDisplay": "$2,250.00",
"proratedItemCredit": 0.00,
"proratedItemCreditDisplay": "$0.00",
"proratedItemSubtotal": 2250.00,
"proratedItemSubtotalDisplay": "$2,250.00",
"proratedItemTax": 157.51,
"proratedItemTaxDisplay": "$157.51",
"proratedItemTotal": 2407.51,
"proratedItemTotalDisplay": "$2,407.51"
}
],
"subscriptionSubtotal": 5518.75,
"subscriptionSubtotalDisplay": "$5,518.75",
"subscriptionTax": 386.33,
"subscriptionTaxDisplay": "$386.33",
"subscriptionTotal": 5905.08,
"subscriptionTotalDisplay": "$5,905.08",
"subscriptionProratedCharge": 5518.75,
"subscriptionProratedChargeDisplay": "$5,518.75"
},
"amountDue": {
"prorationSubtotal": 4518.75,
"prorationSubtotalDisplay": "$4,518.75",
"prorationTax": 316.33,
"prorationTaxDisplay": "$316.33",
"totalAmountDue": 4835.08,
"totalAmountDueDisplay": "$4,835.08",
"nextChargeDate": 1683936000000,
"nextChargeDateDisplay": "5/13/23",
"nextChargeDateDisplayISO8601": "2023-05-13",
"nextChargeAmount": 5905.08,
"nextChargeAmountDisplay": "$5,905.08"
}
}
Error Handling
This table lists errors you may run into when working with this endpoint, as well as solutions to help you troubleshoot.
| Status Code | Error Message | Solution |
|---|---|---|
400 | Request must contain a single root object. | Ensure the request payload contains a single root object. |
400 | Request must contain a subscription ID. | Ensure the subscription ID is included in your request payload. |
400 | Proration is not allowed for this subscription. | Check the subscription's eligibility for proration. |
400 | Refund exceeds the last charge amount. | Ensure the refund amount does not exceed the last charge amount. |
404 | Subscription ID does not exist: [subscriptionId] | Verify the subscription ID is correct and exists. |
500 | Subscription is not changeable | Verify that the subscriptionID is changeable, or try again with a different subscription. |