HomeProduct DocsAPI ReferenceChangelog
RecurlyAPI GuidesRecurly.jsWebhooksAPI ReferenceSupportBook demo
API Reference

Update Subscription Notes

Update a subscription's invoice notes before the next renewal. Updating notes will not trigger the renewal.

Please note that this example is provided for illustrative purposes and is not a separate endpoint from 'Update Subscription'

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Subscription's unique identifier.

Body Params
string

Optional notes field. This will default to the Terms and Conditions text specified on the Invoice Settings page in your Recurly admin, unless custom notes were created with the original subscription. Specify custom notes with this tag to add or override Terms and Conditions. Custom notes will stay with a subscription on all renewals, unless updated before renewal. Will always change immediately, even if timeframe = term_end.

string

Optional notes field. This will default to the Customer Notes text specified on the Invoice Settings page in your Recurly admin, unless custom notes were created with the original subscription. Specify custom notes with this tag to add or override Customer Notes. Custom notes will stay with a subscription on all renewals. Will always change immediately, even if timeframe = term_end.

string

VAT Reverse Charge Notes only appear if you have EU VAT enabled or are using your own Avalara AvaTax account and the customer is in the EU, has a VAT number, and is in a different country than your own. This will default to the VAT Reverse Charge Notes text specified on the Tax Settings page in your Recurly admin, unless custom notes were created with the original subscription. Specify custom notes with this tag to add or override VAT Reverse Charge Notes. Custom notes will stay with a subscription on all renewals. Will always change immediately, even if timeframe = term_end.

custom_fields
array of objects

Optional custom fields for the subscription.

custom_fields
string

An alphanumeric code shown per gateway on your site's payment gateways page. Set this code to ensure that a given subscription targets a given gateway.

Response

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