API reference · Accounts

Create a shareable billing link

POST/v1/accounts/{accountId}/billing-link

Create a link which can be shared to your customer to let them fill their billing and payment information. Restricted to platform accounts who enabled billing delegation to Charitips.

Requires a Bearer access token.

Parameters

This field has no description in the spec.

accountId#stringin pathrequired

Errors

400No domain found for your account

{
  "statusCode": 400,
  "message": "No domain found for your account",
  "error": "Bad Request"
}

401Unauthorized
Missing, expired or invalid access token.
```
{
  "statusCode": 401,
  "message": "Unauthorized"
}
```

402Plan upgrade required

{
  "statusCode": 402,
  "message": "Plan upgrade required"
}

403Forbidden

{
  "statusCode": 403,
  "message": "Forbidden"
}

403Billing delegation is not enabled for this account

{
  "statusCode": 403,
  "message": "Billing delegation is not enabled for this account",
  "error": "Forbidden"
}

403Account closed

{
  "message": "Account closed",
  "code": "ACCOUNT_CLOSED"
}

404Not Found
No resource with this id on your account: the API answers as if it did not exist.
```
{
  "statusCode": 404,
  "message": "Not Found"
}
```

POST /v1/accounts/<accountId>/billing-link

1curl -X POST https://api.sandbox.charitips.com/v1/accounts/<accountId>/billing-link \2  -H "Authorization: Bearer $CHARITIPS_TOKEN"

Built from the spec and the API code

Request bodies are written for this docs and checked against the API's validation; ids in angle brackets are placeholders. Response values are placeholders built from the schema.