v1

latestOpenAPI 3.0.02026-07-2636111249.2 KB
Subscription API

Update Customer

Updates your internal customer ID (<code>CustomerReferenceId</code>) for a subscription. You can use this endpoint to match a unique customer ID (<code>CustomerReferenceId</code>) from your system with the automatically generated <b>Internal customer ID</b> in the Cleverbridge platform when the customer initially purchases the subscription. This way, you'll be able to easily identify any future events related to a customer with multiple subscriptions.<br /><b>Note:</b> The <code>CustomerReferenceId</code> corresponds to the <code>internalCustomer</code> field name (JSON) in the notifications you receive for some events related to one-time or recurring purchases the customer makes.<br />For XML examples and schemas, see the Additional Examples - Update Customer

post/subscription/updatecustomer

Headers

Accept'application/json' | 'application/xml'

Expected response format.

Content-Type'application/json' | 'application/xml'

Format of the HTTP post body.

Request body

CustomerReferenceIdstring

Your unique ID of the customer. This value is submitted by you when the customer initially purchases the subscription and is stored by Cleverbridge. Corresponds to the <b>Internal customer ID</b> in the Cleverbridge platform. For more information, see Customer Data.

SubscriptionIdstring required

Unique ID of the customer's subscription, with or without an initial 'S'.

Response

OK

ResultMessagestring

Optional result or error message.