Skip to main content
POST
Add a recipient to the public checkout cart

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"

entity_id
integer
required

Entity id.

Required range: x >= 1
Example:

4711

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

Validation: required|numeric.

frequency
integer

Frequency ID; omitted defaults to 1 (monthly). A present monthly field also selects monthly.

monthly
string

Presence selects monthly frequency.

is_custom_amount
boolean

Whether the supplied amount is per-period instead of the base amount.

Response

Add a recipient to the public checkout cart response.

message
string
session_id
string