API Reference
Overview
Quick Start
API Authentication
API Error Codes
APIs
Checkout API
Checkout API
Order Details
User History
Prices
Product API
Product API
Coupons
Products
Licenses
Pay Links
Transactions
Payments
Subscription API
Subscription API
Plans
Users
List Users
post
Update User
post
Cancel User
post
Update Postcode
post
Modifiers
Payments
One-off Charges
Alert API
Alert API
Webhooks

Update Postcode

post
/2.0/subscription/users/postcode

Example Request

preparing...
  • The updated postcode will be applied to all subscription invoices
  • The Subscription Updated webhook will not be fired when this API is used.
  • The API will not change the country associated with the subscription.
vendor_id
integer
required

The vendor ID identifies your seller account. This can be found in Developer Tools > Authentication.

>= 1
vendor_auth_code
string
required

The vendor auth code is a private API key for authenticating API requests. This key should never be used in client side code or shared publicly. This can be found in Developer Tools > Authentication.

Match pattern:
[0-9a-f]+
subscription_id
integer
required

The ID of the subscription you’re updating.

postcode
string
required

The new postcode to be applied to the subscription.

Body
:
:
:
: