curl --request POST \
--url https://api.paygentic.io/v0/consumers \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"name": "<string>",
"email": "jsmith@example.com",
"metadata": {},
"phone": "<string>",
"address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"country": "<string>",
"zipCode": "<string>"
},
"organizationId": "<string>"
}'
{
"id": "<string>",
"object": "consumer",
"name": "<string>",
"email": "jsmith@example.com",
"metadata": {},
"phone": "<string>",
"address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"country": "<string>",
"zipCode": "<string>"
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
Create a new consumer. A consumer represents an entity that consumes a Merchant
’s Product
. Consumers can have one or more subscriptions
, monitor wallet balances, analyze usage, and manage their subscriptions from a single entrypoint.
curl --request POST \
--url https://api.paygentic.io/v0/consumers \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"name": "<string>",
"email": "jsmith@example.com",
"metadata": {},
"phone": "<string>",
"address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"country": "<string>",
"zipCode": "<string>"
},
"organizationId": "<string>"
}'
{
"id": "<string>",
"object": "consumer",
"name": "<string>",
"email": "jsmith@example.com",
"metadata": {},
"phone": "<string>",
"address": {
"line1": "<string>",
"line2": "<string>",
"city": "<string>",
"state": "<string>",
"country": "<string>",
"zipCode": "<string>"
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Consumer created successfully
The response is of type object
.