Subscriptions

Replace subscription cart

Replaces the subscription's current cart with a new one built from the submitted customer data and, when supplied, a new set of cart items. The outgoing cart and its link are voided. No SMS is sent: call POST /api/public/v1/subscriptions/{id}/send_sms afterwards to hand the new link to the shopper.

post/api/public/v1/subscriptions/{id}/replace

Request

  • Base URL
    http://localhost:3009
  • URL
    http://localhost:3009/api/public/v1/subscriptions/{id}/replace
  • Auth
    HTTP basic

Path parameters

idstring required

Subscription ID (integer)

Headers

Authorizationstring required

Request body

referencestring

Merchant reference for the new cart. Merchants whose references are auto-generated keep the outgoing cart's reference and this field is ignored.

mobile_phonestring required
operator_refstring

Email of the operator the replacement is attributed to, as POST /api/public/v1/subscriptions takes it.

given_namesstring
surnamesstring

Customer's combined surnames. Use first_surname + second_surname instead for Mexican merchants.

first_surnamestring
second_surnamestring
date_of_birthstring
ninstring
nin_controlstring
addressstring
postal_codestring
citystring
colonystring
emailstring
joint_customerstring

Response

cart replaced - the subscription resource, as POST /api/public/v1/subscriptions returns it

Changes

No recorded changes to this operation across all 1 revision of this API.