API ReferenceSubscriptions

Update subscription by email

Update a single subscription by email.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

publicationIdstringRequiredformat: "^(pub_[0-9a-fA-F\-]+)$"
The prefixed ID of the publication object
emailstringRequired
The email of the subscription object

Request

This endpoint expects an object.
tierenumOptional
Optional parameter to set the tier for this subscription.
Allowed values:
stripe_customer_idstringOptionalformat: "^(cus_[0-9a-zA-Z]+)?$"

The Stripe Customer ID of the subscription (not required)

unsubscribebooleanOptional

A boolean value specifying whether to unsubscribe this subscription from the publication (not required)

custom_fieldslist of objectsOptional
An array of custom field objects to update

Response

OK
dataobject
The subscription object

Errors