Purchases

POST /api/public/purchases/{purchaseId}/renew

Changed on

Renew a membership for another period of its product duration and reset the period usage count. Memberships only. Records the renewal payment details; it does not charge anyone.

Request

  • Base URL
    https://api.coach-platform.com
  • Auth
    HTTP bearer

Path parameters

purchaseIdstring required

Headers

Idempotency-Keystring

Optional. Send a unique key (e.g. a UUID) to make this POST safe to retry. The same key within 24h returns the original result instead of creating a duplicate.

Request body

paymentAmountnumber

Amount paid for the renewal. Replaces purchaseAmount when sent.

paymentMethod'Cash' | 'Credit card' | 'Bank transfer' | 'Other'
paymentReferencestring
notestring

Response

Successful response

Changes