Update Membership

PATCH /memberships/:membershipId

You can update the following fields:

PropertyTypeDescription
autoRenewbooleanWhether the membership renews automatically
validFromstring (YYYY-MM-DD)Date for when the membership starts
validTostring (YYYY-MM-DD)Date for when the membership expires. Including the date
payerIdstring (UUIDv4) or nullThe customer who paid for the membership. Set or change it with the customer's id; null removes the payer. The membership is then listed in that customer's paidMemberships instead of the previous payer's

The payer must be a customer of your organization, not deleted, in the same mode (live or test) as your key. Otherwise the request fails with 400 and PAYER_NOT_FOUND. A payerId that is neither a string nor null fails with PAYER_ID_NOT_STRING. Other fields fail with FIELD_NOT_ALLOWED.

The response is the updated Membership, with changeLog.

‹ Previous
Create Membership
Next ›
Delete Membership