Skip to main content
POST
Add the configured optional sponsorship to a checkout

Path Parameters

client_id
integer
required

Client id.

Required range: x >= 1
Example:

207

program_id
string
required

Program id. Program route; order/cart methods may accept hyphen-separated program IDs.

Example:

"11"

session_id
string
required

Session id. Frontend or recipient session ID belonging to this organization.

Example:

"checkout-session-from-response"

Body

application/json

Request fields accepted by this operation. Omitted optional properties retain the behavior described above.

sponsorship_amount
number
required
Required range: x > 0
frequency
integer
required

One of the frequency IDs currently allowed by the resolved offer.

Example:

1

is_custom_amount
boolean

Response

Add the configured optional sponsorship to a checkout response.

message
string
session_id
string