Pick the Get Subscription Change action (under subscription_change).
Fill in the fields below, then reference the result from later steps as {{getSubscriptionChange.response.data}}.
Request
Path parameters
subscription_idstringrequired
Subscription ID or UUID. For ID no prefix is used e.g. `e28zov4fw0v2`. For UUID use prefix `uuid-`, e.g. `uuid-123457890`.
Response
Returns 200 with an object. Read it in later steps with {{getSubscriptionChange.response.data.<field>}}.
idstring
The ID of the Subscription Change.
objectstring
subscription_idstring
The ID of the subscription that is going to be changed.
planobject
Just the important parts.
idstring
objectstring
codestring
Unique code to identify the plan. This is used in Hosted Payment Page URLs and in the invoice exports.
namestring
This name describes your plan and will appear on the Hosted Payment Page and the subscriber's invoice.
add_onsarray<object>
These add-ons will be used when the subscription renews.
idstring
objectstring
subscription_idstring
add_onobject11 fields
Just the important parts.
add_on_sourcestring
Used to determine where the associated add-on data is pulled from. If this value is set to
`plan_add_on` or left blank, then add-on data will be pulled from the plan's add-ons. If the associated
`plan` has `allow_any_item_on_subscriptions` set to `true` and this field is set to `item`, then
the associated add-on data will be pulled from the site's item catalog.
One ofplan_add_onitemDefault "plan_add_on"
quantityinteger
unit_amountnumber (float)
Supports up to 2 decimal places.
unit_amount_decimalstring (decimal)
Supports up to 9 decimal places.
revenue_schedule_typestring
One ofat_range_endat_range_startevenlynever
tier_typestring
The pricing model for the add-on. For more information,
[click here](https://docs.recurly.com/docs/billing-models#section-quantity-based). See our
[Guide](https://recurly.com/developers/guides/item-addon-guide.html) for an overview of how
to configure quantity-based pricing models.
One offlattieredstairstepvolumeDefault "flat"
usage_calculation_typestring
The type of calculation to be employed for an add-on. Cumulative billing will sum all usage records created in the current billing cycle. Last-in-period billing will apply only the most recent usage record in the billing period. If no value is specified, cumulative billing will be used.
One ofcumulativelast_in_period
usage_timeframestring
The time at which usage totals are reset for billing purposes.
One ofbilling_periodsubscription_termDefault "billing_period"
tiersarray<object>4 fields
If tiers are provided in the request, all existing tiers on the Subscription Add-on will be
removed and replaced by the tiers in the request. If add_on.tier_type is tiered or volume and
add_on.usage_type is percentage use percentage_tiers instead.
There must be one tier without an `ending_quantity` value which represents the final tier.
percentage_tiersarray<object>2 fields
If percentage tiers are provided in the request, all existing percentage tiers on the Subscription Add-on will be
removed and replaced by the percentage tiers in the request. Use only if add_on.tier_type is tiered or volume and
add_on.usage_type is percentage. There must be one tier without an `ending_amount` value which represents the final tier.
This feature is currently in development and requires approval and enablement, please contact support.
usage_percentagenumber (float)
The percentage taken of the monetary amount of usage tracked. This can be up to 4 decimal places. A value between 0.0 and 100.0. Required if add_on_type is usage and usage_type is percentage.
created_atstring (date-time)
updated_atstring (date-time)
expired_atstring (date-time)
unit_amountnumber (float)
tax_inclusiveboolean
This field is deprecated. Please do not use it.
Default false
quantityinteger
shippingobject
objectstring
addressobject19 fields
methodobject4 fields
amountnumber (float)
activate_atstring (date-time)
activatedboolean
Returns `true` if the subscription change is activated.
revenue_schedule_typestring
One ofat_range_endat_range_startevenlynever
invoice_collectionobject
objectstring
charge_invoiceobject40 fields
credit_invoicesarray<object>40 fields
verification_transactionsarray<object>40 fields
Verification transactions (used for free trial payment method validation)
business_entityobject
Business entity details
idstring
objectstring
codestring
The entity code of the business entity.
namestring
This name describes your business entity and will appear on the invoice.
custom_fieldsarray<object>
The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.
namestringrequired
Fields must be created in the UI before values can be assigned to them.
valuestringrequired
Any values that resemble a credit card number or security code (CVV/CVC) will be rejected.
source_record_typestring
The type of record a custom field was automatically copied from.
One ofaccountplanproductsubscription
source_record_idstring
The UUID of the record this custom field was automatically copied from. Only present when the field was copied from another record.
created_atstring (date-time)
updated_atstring (date-time)
deleted_atstring (date-time)
billing_infoobject
Accept nested attributes for three_d_secure_action_result_token_id
three_d_secure_action_result_token_idstring
A token generated by Recurly.js after completing a 3-D Secure device fingerprinting or authentication challenge.
ramp_intervalsarray<object>
The ramp intervals representing the pricing schedule for the subscription.
starting_billing_cycleinteger
Represents the billing cycle where a ramp interval starts.
remaining_billing_cyclesinteger
Represents how many billing cycles are left in a ramp interval.
starting_onstring (date-time)
ending_onstring (date-time)
unit_amountnumber (float)
Represents the price for the ramp interval.
next_bill_datestring (date-time)
If present, this sets the date the subscription's next billing period will start (`current_period_ends_at`). When combined with proration_settings, proration calculation should occur, only supported when timeframe is now.
