Replace subscription cart

post

http://localhost:3009/api/public/v1/subscriptions/{id}/replace

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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

Subscription ID (integer)

Body Params

Customer data, phone and optionally the cart items the replacement is built from. This is the body POST /api/public/v1/subscriptions takes, and it is accepted or refused on exactly the same rules: a customer field that create requires and this body leaves out is answered 422 and nothing is replaced. The customer block is replaced as a whole: send every customer field the new cart is to carry, because a field this body leaves out is not copied over from the outgoing cart. Send no customer field at all to keep the customer data the outgoing cart holds.

reference

string

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

mobile_phone

string

required

operator_ref

string

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

given_names

string

surnames

string

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

first_surname

string

second_surname

string

date_of_birth

string

nin

string

nin_control

string

address

string

postal_code

string

city

string

colony

string

joint_customer

string

cart_items

array

Omit to keep the outgoing cart's items and the subscription's discounts. When supplied, both are rebuilt from this payload.

cart_items

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Basic

base64

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/html

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

401the credentials are missing or wrong

404no subscription with that id is reachable with these credentials

409the cart can no longer be replaced

422the body is refused - here a customer block missing a required field