Developer Hub
Sign In

Preview a prorated plan change

post
https://api.fastspring.com/subscriptions/estimate

Generates a preview of the estimated charges, credits, or refunds for a subscription before making any changes.

This endpoint returns a prorated estimate for only one subscription per request.

Body Params
string
required

Unique identifier for the subscription.

string

Product identifier for the subscription change.

int32

Quantity of the product.

pricing
object
required

Pricing details for the subscription.

addons
array of objects

List of add-ons included in the subscription.

addons
boolean

Indicates whether the subscription change should be prorated.

coupons
array of strings

Array of coupon codes to be applied to the subscription.

⚠️ Note: This field is permissive. If an invalid coupon is provided, the API ignores it and returns a 200 OK (rather than a 400 error).

You must verify the discount field inside the proposedPlan object (i.e., proposedPlan.discount) to confirm the coupon was successfully applied.

coupons
Responses

Updated 4 months ago

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago