Latest Live API
- Account
- Billing
- Collections
- Customer
- Invoices
- Notifications
- Product
- Quote
- Taxes
- Usage
Version 2024-07-30
- Account
- Billing
- Collections
- Customer
- Invoices
- Notifications
- Product
- Quote
- Taxes
- Usage
Credits
Create a new credit grant
Create a new credit grant
POST
/
credits
Copy
Ask AI
curl --request POST \
--url https://eu.sequencehq.com/api/credits \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '{
"sequenceAccountId": "dce9ae85-d8d0-42b4-bcad-f221a64363c6",
"customerId": "61b083e0-1faa-47ca-9aeb-6205da8f6c47",
"name": "Onboarding Credits",
"creditUnitType": "CURRENCY",
"currency": "GBP",
"metricId": "f092246c-6b90-4106-bcca-304ccf06bf45",
"amount": 10,
"costOfCredit": 10,
"effectiveDate": "2023-01-01",
"expiryDate": "2023-01-31",
"createInvoice": true
}'
Copy
Ask AI
{
"id": "746fc7f2-8098-4fe7-953c-7d51c580a126",
"sequenceAccountId": "dce9ae85-d8d0-42b4-bcad-f221a64363c6",
"customerId": "61b083e0-1faa-47ca-9aeb-6205da8f6c47",
"name": "Onboarding Credits",
"creditUnitType": "CURRENCY",
"currency": "GBP",
"metricId": "f092246c-6b90-4106-bcca-304ccf06bf45",
"amount": 10,
"costOfCredit": 10,
"effectiveDate": "2023-01-01",
"expiryDate": "2023-01-31",
"createdAt": "2022-10-07T14:12:08.826121Z",
"integrationIds": [
{
"service": "Xero",
"id": "74ed2615-4730-49ab-9445-74f31723a206",
"isPending": false
}
]
}
Headers
Your API credentials. Eg. Basic {credentials}
.
Use this header to select an API version
Available options:
2024-07-30
Body
application/json
Response
201
application/json
Created
The response is of type object
.
Copy
Ask AI
curl --request POST \
--url https://eu.sequencehq.com/api/credits \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '{
"sequenceAccountId": "dce9ae85-d8d0-42b4-bcad-f221a64363c6",
"customerId": "61b083e0-1faa-47ca-9aeb-6205da8f6c47",
"name": "Onboarding Credits",
"creditUnitType": "CURRENCY",
"currency": "GBP",
"metricId": "f092246c-6b90-4106-bcca-304ccf06bf45",
"amount": 10,
"costOfCredit": 10,
"effectiveDate": "2023-01-01",
"expiryDate": "2023-01-31",
"createInvoice": true
}'
Copy
Ask AI
{
"id": "746fc7f2-8098-4fe7-953c-7d51c580a126",
"sequenceAccountId": "dce9ae85-d8d0-42b4-bcad-f221a64363c6",
"customerId": "61b083e0-1faa-47ca-9aeb-6205da8f6c47",
"name": "Onboarding Credits",
"creditUnitType": "CURRENCY",
"currency": "GBP",
"metricId": "f092246c-6b90-4106-bcca-304ccf06bf45",
"amount": 10,
"costOfCredit": 10,
"effectiveDate": "2023-01-01",
"expiryDate": "2023-01-31",
"createdAt": "2022-10-07T14:12:08.826121Z",
"integrationIds": [
{
"service": "Xero",
"id": "74ed2615-4730-49ab-9445-74f31723a206",
"isPending": false
}
]
}
Assistant
Responses are generated using AI and may contain mistakes.