API docs by Redocly

BillaBear (1.1.0)

Download OpenAPI specification:Download

API Support: support@billabear.com URL: http://www.billabear.com/support License: FCL

The REST API provided by BillaBear

Billing

Customers

List

List all customers

Authorizations:
ApiKeyAuth
query Parameters
limit
integer <int32>

How many items to return at one time (max 100)

last_key
string

The key to be used in pagination to say what the last key of the previous page was

email
string

The email to search for

country
string

The country code to search for

reference
string

The reference to search for

external_reference
string

The external reference to search for

company_name
string

The company name to search for

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "has_more": true,
  • "last_key": "dc625535-d212-4c71-bf5c-662190b1b4de"
}

Create

Create a customer

Authorizations:
ApiKeyAuth
Request Body schema: application/json
id
string <uuid>
email
required
string
tax_number
string or null

The tax number for the customer Since 1.1

standard_tax_rate
float or null

The tax rate for the customer on for standard services a Since 1.1

digital_tax_rate
float or null

The tax rate for the customer on digital services Since 1.1

billing_type
string or null
Enum: "card" "invoice"

Choice between card and invoice

type
string or null
Enum: "individual" "business"

Choice between 'individual' and 'business'. When not provided 'individual' is used. Since 1.1

reference
string
external_reference
string
object (Address)
locale
string or null

Defaults to 'en' if not sent.

brand
string or null

Defaults to 'default' if not sent.

invoice_format
string or null
Enum: "pdf" "xrechnung"

Choice between 'pdf' and 'xrechnung'. Since 2024.02.01

marketing_opt_in
boolean or null

If the customer has opted in for marketing

metadata
object

Any metadata you want to add to a customer

Responses

Request samples

Content type
application/json
{
  • "email": "iain.cambridge@example.org"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "email": "iain.cambridge@example.org",
  • "tax_number": "GB459324",
  • "standard_tax_rate": "15",
  • "digital_tax_rate": "19.5",
  • "billing_type": "card",
  • "type": "business",
  • "reference": "internal-id",
  • "external_reference": "string",
  • "address": {
    },
  • "locale": "en",
  • "brand": "default",
  • "invoice_format": "pdf",
  • "marketing_opt_in": true,
  • "metadata": { }
}

Detail

Info for a specific customer

Authorizations:
ApiKeyAuth
path Parameters
customerId
required
string

The id of the customer to retrieve

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "email": "iain.cambridge@example.org",
  • "tax_number": "GB459324",
  • "standard_tax_rate": "15",
  • "digital_tax_rate": "19.5",
  • "billing_type": "card",
  • "type": "business",
  • "reference": "internal-id",
  • "external_reference": "string",
  • "address": {
    },
  • "locale": "en",
  • "brand": "default",
  • "invoice_format": "pdf",
  • "marketing_opt_in": true,
  • "metadata": { }
}

Update

Update a customer

Authorizations:
ApiKeyAuth
path Parameters
customerId
required
string

The id of the customer to retrieve

Request Body schema: application/json
id
string <uuid>
email
required
string
tax_number
string or null

The tax number for the customer Since 1.1

standard_tax_rate
float or null

The tax rate for the customer on for standard services a Since 1.1

digital_tax_rate
float or null

The tax rate for the customer on digital services Since 1.1

billing_type
string or null
Enum: "card" "invoice"

Choice between card and invoice

type
string or null
Enum: "individual" "business"

Choice between 'individual' and 'business'. When not provided 'individual' is used. Since 1.1

reference
string
external_reference
string
object (Address)
locale
string or null

Defaults to 'en' if not sent.

brand
string or null

Defaults to 'default' if not sent.

invoice_format
string or null
Enum: "pdf" "xrechnung"

Choice between 'pdf' and 'xrechnung'. Since 2024.02.01

marketing_opt_in
boolean or null

If the customer has opted in for marketing

metadata
object

Any metadata you want to add to a customer

Responses

Request samples

Content type
application/json
{
  • "email": "iain.cambridge@example.org"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "email": "iain.cambridge@example.org",
  • "tax_number": "GB459324",
  • "standard_tax_rate": "15",
  • "digital_tax_rate": "19.5",
  • "billing_type": "card",
  • "type": "business",
  • "reference": "internal-id",
  • "external_reference": "string",
  • "address": {
    },
  • "locale": "en",
  • "brand": "default",
  • "invoice_format": "pdf",
  • "marketing_opt_in": true,
  • "metadata": { }
}

Apply voucher

Apply Voucher to Customer

Authorizations:
ApiKeyAuth
path Parameters
customerId
required
string

The id of the customer to retrieve

Request Body schema: application/json
code
required
string

Responses

Request samples

Content type
application/json
{
  • "code": "vouch50"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

Usage Cost Estimate

The estimated costs from usage based billing for a customer

Authorizations:
ApiKeyAuth
path Parameters
customerId
required
string

The id of the customer to retrieve

Responses

Response samples

Content type
application/json
{
  • "costs": [
    ],
  • "cost": {
    }
}

Disable Customer

Disable customer

Authorizations:
ApiKeyAuth
path Parameters
customerId
required
string

The id of the customer to retrieve

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

Enable Customer

Enable a customer

Authorizations:
ApiKeyAuth
path Parameters
customerId
required
string

The id of the customer to retrieve

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

Fetch Customer Limits

Limits for a specific customer

Authorizations:
ApiKeyAuth
path Parameters
customerId
required
string

The id of the customer to retrieve

Responses

Response samples

Content type
application/json
{
  • "limits": [
    ],
  • "features": [
    ],
  • "user_count": 0
}

List Customer Refunds

List Customer Refund

Authorizations:
ApiKeyAuth
path Parameters
customerId
required
string

The id of the customer to retrieve

query Parameters
limit
integer <int32>

How many items to return at one time (max 100)

last_key
string

The key to be used in pagination to say what the last key of the previous page was

name
string

The name to search for

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "has_more": true,
  • "last_key": "dc625535-d212-4c71-bf5c-662190b1b4de"
}

List Customer Payments

List Customer Payment

Authorizations:
ApiKeyAuth
path Parameters
customerId
required
string

The id of the customer to retrieve

query Parameters
limit
integer <int32>

How many items to return at one time (max 100)

last_key
string

The key to be used in pagination to say what the last key of the previous page was

name
string

The name to search for

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "has_more": true,
  • "last_key": "dc625535-d212-4c71-bf5c-662190b1b4de"
}

Fetch Customer Usage Limits

Usage Limits for a specific customer

Authorizations:
ApiKeyAuth
path Parameters
customerId
required
string

The id of the customer to retrieve

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "has_more": true,
  • "last_key": "dc625535-d212-4c71-bf5c-662190b1b4de"
}

Create Usage Limit

Create Usage Limit for the custoemr

Authorizations:
ApiKeyAuth
path Parameters
customerId
required
string

The id of the customer to retrieve

Request Body schema: application/json
amount
required
integer
action
required
string
Enum: "WARNING" "DISABLE"

Responses

Request samples

Content type
application/json
{
  • "amount": 2000,
  • "action": "WARNING"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "amount": "SaaS",
  • "action": "WARNING"
}

Delete Usage Limit

Delete Usage Limit for the custoemr

Authorizations:
ApiKeyAuth
path Parameters
customerId
required
string

The id of the customer to retrieve

usageLimitId
required
string

The id of the usage limit

Responses

List Customer Invoices

List Customer Invoices

Authorizations:
ApiKeyAuth
path Parameters
customerId
required
string

The id of the customer to retrieve

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "has_more": true,
  • "last_key": "dc625535-d212-4c71-bf5c-662190b1b4de"
}

List Customer's Payment Details

List all customers

Added in version 1.1

Authorizations:
ApiKeyAuth
path Parameters
customerId
required
string

The id of the customer to retrieve

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "has_more": true,
  • "last_key": "dc625535-d212-4c71-bf5c-662190b1b4de"
}

List Customer Subscriptions

List all customer subscriptions

Since 1.1

Authorizations:
ApiKeyAuth
path Parameters
customerId
required
string

The id of the customer to retrieve

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "has_more": true,
  • "last_key": "dc625535-d212-4c71-bf5c-662190b1b4de"
}

List Customer Active Subscriptions

List all Active customer subscriptions

Authorizations:
ApiKeyAuth
path Parameters
customerId
required
string

The id of the customer to retrieve

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "has_more": true,
  • "last_key": "dc625535-d212-4c71-bf5c-662190b1b4de"
}

Add Seats

Adds seats to a per seat subscription

Since 1.1.4

Authorizations:
ApiKeyAuth
path Parameters
subscriptionId
required
string

The id of the subscription to retrieve

Request Body schema: application/json
seats
required
integer

Responses

Request samples

Content type
application/json
{
  • "seats": 2
}

Response samples

Content type
application/json
{
  • "success": true
}

Remove Seats

Remove seats to a per seat subscription

Since 1.1.4

Authorizations:
ApiKeyAuth
path Parameters
subscriptionId
required
string

The id of the subscription to retrieve

Request Body schema: application/json
seats
required
integer

Responses

Request samples

Content type
application/json
{
  • "seats": 2
}

Response samples

Content type
application/json
{
  • "success": true
}

Usage

Usage Cost Estimate

The estimated costs from usage based billing for a customer

Authorizations:
ApiKeyAuth
path Parameters
customerId
required
string

The id of the customer to retrieve

Responses

Response samples

Content type
application/json
{
  • "costs": [
    ],
  • "cost": {
    }
}

Fetch Customer Usage Limits

Usage Limits for a specific customer

Authorizations:
ApiKeyAuth
path Parameters
customerId
required
string

The id of the customer to retrieve

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "has_more": true,
  • "last_key": "dc625535-d212-4c71-bf5c-662190b1b4de"
}

Create Usage Limit

Create Usage Limit for the custoemr

Authorizations:
ApiKeyAuth
path Parameters
customerId
required
string

The id of the customer to retrieve

Request Body schema: application/json
amount
required
integer
action
required
string
Enum: "WARNING" "DISABLE"

Responses

Request samples

Content type
application/json
{
  • "amount": 2000,
  • "action": "WARNING"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "amount": "SaaS",
  • "action": "WARNING"
}

Delete Usage Limit

Delete Usage Limit for the custoemr

Authorizations:
ApiKeyAuth
path Parameters
customerId
required
string

The id of the customer to retrieve

usageLimitId
required
string

The id of the usage limit

Responses

Create Event

Creates an event that is used for usage billing

Authorizations:
ApiKeyAuth
Request Body schema: application/json
event_id
required
string <uuid>
subscription
required
string <uuid>
properties
object
value
required
float
code
required
string

Responses

Request samples

Content type
application/json
{
  • "event_id": "a7a26ff2-e851-45b6-9634-d595f45458b7",
  • "subscription": "da7489c5-d730-47b7-9958-07300ef9d3d8",
  • "value": 1,
  • "code": "code_one"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

Refunds

List Customer Refunds

List Customer Refund

Authorizations:
ApiKeyAuth
path Parameters
customerId
required
string

The id of the customer to retrieve

query Parameters
limit
integer <int32>

How many items to return at one time (max 100)

last_key
string

The key to be used in pagination to say what the last key of the previous page was

name
string

The name to search for

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "has_more": true,
  • "last_key": "dc625535-d212-4c71-bf5c-662190b1b4de"
}

List

List all refund

Authorizations:
ApiKeyAuth
query Parameters
limit
integer <int32>

How many items to return at one time (max 100)

last_key
string

The key to be used in pagination to say what the last key of the previous page was

name
string

The name to search for

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "has_more": true,
  • "last_key": "dc625535-d212-4c71-bf5c-662190b1b4de"
}

Detail

Info for a specific Refund

Authorizations:
ApiKeyAuth
path Parameters
refundId
required
string

The id of the refund

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "amount": 1000,
  • "currency": "EUR",
  • "external_reference": "string",
  • "comment": "Customer thought they cancelled but had not",
  • "status": "started",
  • "created_at": "string",
  • "payment": {
    },
  • "customer": {
    },
  • "billing_admin": {
    }
}

Payments

List Customer Payments

List Customer Payment

Authorizations:
ApiKeyAuth
path Parameters
customerId
required
string

The id of the customer to retrieve

query Parameters
limit
integer <int32>

How many items to return at one time (max 100)

last_key
string

The key to be used in pagination to say what the last key of the previous page was

name
string

The name to search for

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "has_more": true,
  • "last_key": "dc625535-d212-4c71-bf5c-662190b1b4de"
}

List Customer Invoices

List Customer Invoices

Authorizations:
ApiKeyAuth
path Parameters
customerId
required
string

The id of the customer to retrieve

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "has_more": true,
  • "last_key": "dc625535-d212-4c71-bf5c-662190b1b4de"
}

List

List all payment

Authorizations:
ApiKeyAuth
query Parameters
limit
integer <int32>

How many items to return at one time (max 100)

last_key
string

The key to be used in pagination to say what the last key of the previous page was

name
string

The name to search for

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "has_more": true,
  • "last_key": "dc625535-d212-4c71-bf5c-662190b1b4de"
}

Refund Payment

Issue a refund for payment

Authorizations:
ApiKeyAuth
path Parameters
paymentId
required
string

The id of the payment

Request Body schema: application/json
amount
required
integer
currency
string or null

Three-letter ISO currency code. Must be upper-case

reason
string or null

Responses

Request samples

Content type
application/json
{
  • "amount": 1000
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

Charge Invoice

Attempts to charge a card that is on file for the invoice amount

Authorizations:
ApiKeyAuth
path Parameters
invoiceId
required
string

The id of the invoice

Responses

Response samples

Content type
application/json
{
  • "paid": true,
  • "failure_reason": "expired_card"
}

Download Invoice

Returns the pdf blob for the invoice

Authorizations:
ApiKeyAuth
path Parameters
invoiceId
required
string

The id of the invoice

Responses

Download Receipt

Returns the pdf blob for the Receipt

Authorizations:
ApiKeyAuth
path Parameters
receipt
required
string

The id of the receipt

Responses

Invoices

List Customer Invoices

List Customer Invoices

Authorizations:
ApiKeyAuth
path Parameters
customerId
required
string

The id of the customer to retrieve

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "has_more": true,
  • "last_key": "dc625535-d212-4c71-bf5c-662190b1b4de"
}

Charge Invoice

Attempts to charge a card that is on file for the invoice amount

Authorizations:
ApiKeyAuth
path Parameters
invoiceId
required
string

The id of the invoice

Responses

Response samples

Content type
application/json
{
  • "paid": true,
  • "failure_reason": "expired_card"
}

Download Invoice

Returns the pdf blob for the invoice

Authorizations:
ApiKeyAuth
path Parameters
invoiceId
required
string

The id of the invoice

Responses

PaymentDetails

Start Frontend Detail Collection

Start frontend payment details

Authorizations:
ApiKeyAuth
path Parameters
customerId
required
string

The id of the customer to retrieve

Responses

Response samples

Content type
application/json
{
  • "token": "dummy-token-here"
}

Complete Frontend Detail Collection

Complete frontend payment details

Authorizations:
ApiKeyAuth
path Parameters
customerId
required
string

The id of the customer to retrieve

Request Body schema: application/json
token
required
string

Responses

Request samples

Content type
application/json
{
  • "token": "dummy-token-here"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "default": true,
  • "brand": "visa",
  • "last_four": 484,
  • "expiry_month": 1,
  • "expiry_year": 26,
  • "created_at": "string"
}

Delete With Customer

Delete Payment Details

Authorizations:
ApiKeyAuth
path Parameters
customerId
required
string

The id of the customer to retrieve

paymentDetailsId
required
string

The id of the payment details

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

Delete

Delete Payment Details

Authorizations:
ApiKeyAuth
path Parameters
paymentDetailsId
required
string

The id of the payment details

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

Fetch

Fetch the payment cards

Authorizations:
ApiKeyAuth
path Parameters
paymentDetailsId
required
string

The id of the payment details

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "default": true,
  • "brand": "visa",
  • "last_four": 484,
  • "expiry_month": 1,
  • "expiry_year": 26,
  • "created_at": "string"
}

List Customer's Payment Details

List all customers

Added in version 1.1

Authorizations:
ApiKeyAuth
path Parameters
customerId
required
string

The id of the customer to retrieve

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "has_more": true,
  • "last_key": "dc625535-d212-4c71-bf5c-662190b1b4de"
}

Make Default With Customer

Delete Payment Details

Authorizations:
ApiKeyAuth
path Parameters
customerId
required
string

The id of the customer to retrieve

paymentDetailsId
required
string

The id of the payment details

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

Make Default

Delete Payment Details

Authorizations:
ApiKeyAuth
path Parameters
customerId
required
string

The id of the customer to retrieve

paymentDetailsId
required
string

The id of the payment details

Responses

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

Subscriptions

Create Subscription

Create subscription for a customer

Authorizations:
ApiKeyAuth
path Parameters
customerId
required
string

The id of the customer to retrieve

Request Body schema: application/json
subscription_plan
required
string <uuid>

The ID for the subscription plan to be used (Can also be the code name)

payment_details
string <uuid>

The Id for the customer's payment details to be used

card_token
string

A stripe card token that's been created using Stripe's js sdk. It'll create the payment details for the customer.

price
string <uuid>

The ID for the price to be used

schedule
string
Enum: "week" "month" "year" "one-off"

The schedule of the plan that is to be started. Only used if price isn't given. Requires currency as well.

currency
string

The currency of the plan that is to be started. Only used if price isn't given. Requires schedule as well.

seat_numbrers
integer
deny_trial
bool
metadata
object

Any metadata you want to add to a subscription

Responses

Request samples

Content type
application/json
{
  • "subscription_plan": "540c4716-c550-4c8b-8ccc-e0378e695ce2"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "seat_number": 1,
  • "schedule": "month",
  • "status": "string",
  • "created_at": "string",
  • "updated_at": "string",
  • "ended_at": "string",
  • "valid_until": "string",
  • "main_external_reference": "string",
  • "child_external_reference": "string",
  • "metadata": { },
  • "price": {
    },
  • "plan": {
    }
}

Start Trial Subscription For Customer

Start subscription for a customer

Authorizations:
ApiKeyAuth
path Parameters
customerId
required
string

The id of the customer to retrieve

Request Body schema: application/json
subscription_plan
required
string <uuid>

The ID for the subscription plan to be used (Can also be the code name)

card_token
string

A stripe card token that's been created using Stripe's js sdk. It'll create the payment details for the customer.

seat_numbrers
integer or null
trial_length_days
integer or null

Responses

Request samples

Content type
application/json
{
  • "subscription_plan": "540c4716-c550-4c8b-8ccc-e0378e695ce2"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "seat_number": 1,
  • "schedule": "month",
  • "status": "string",
  • "created_at": "string",
  • "updated_at": "string",
  • "ended_at": "string",
  • "valid_until": "string",
  • "main_external_reference": "string",
  • "child_external_reference": "string",
  • "metadata": { },
  • "price": {
    },
  • "plan": {
    }
}

List Customer Subscriptions

List all customer subscriptions

Since 1.1

Authorizations:
ApiKeyAuth
path Parameters
customerId
required
string

The id of the customer to retrieve

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "has_more": true,
  • "last_key": "dc625535-d212-4c71-bf5c-662190b1b4de"
}

List Customer Active Subscriptions

List all Active customer subscriptions

Authorizations:
ApiKeyAuth
path Parameters
customerId
required
string

The id of the customer to retrieve

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "has_more": true,
  • "last_key": "dc625535-d212-4c71-bf5c-662190b1b4de"
}

List

List all subscriptions

Authorizations:
ApiKeyAuth
query Parameters
limit
integer <int32>

How many items to return at one time (max 100)

last_key
string

The key to be used in pagination to say what the last key of the previous page was

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "has_more": true,
  • "last_key": "dc625535-d212-4c71-bf5c-662190b1b4de"
}

List Subscription Plans

List all subscriptions plans

Authorizations:
ApiKeyAuth
query Parameters
limit
integer <int32>

How many items to return at one time (max 100)

last_key
string

The key to be used in pagination to say what the last key of the previous page was

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "has_more": true,
  • "last_key": "dc625535-d212-4c71-bf5c-662190b1b4de"
}

Detail

Info for a specific subscription

Authorizations:
ApiKeyAuth
path Parameters
subscriptionId
required
string

The id of the subscription to retrieve

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "seat_number": 1,
  • "schedule": "month",
  • "status": "string",
  • "created_at": "string",
  • "updated_at": "string",
  • "ended_at": "string",
  • "valid_until": "string",
  • "main_external_reference": "string",
  • "child_external_reference": "string",
  • "metadata": { },
  • "price": {
    },
  • "plan": {
    }
}

Add Seats

Adds seats to a per seat subscription

Since 1.1.4

Authorizations:
ApiKeyAuth
path Parameters
subscriptionId
required
string

The id of the subscription to retrieve

Request Body schema: application/json
seats
required
integer

Responses

Request samples

Content type
application/json
{
  • "seats": 2
}

Response samples

Content type
application/json
{
  • "success": true
}

Remove Seats

Remove seats to a per seat subscription

Since 1.1.4

Authorizations:
ApiKeyAuth
path Parameters
subscriptionId
required
string

The id of the subscription to retrieve

Request Body schema: application/json
seats
required
integer

Responses

Request samples

Content type
application/json
{
  • "seats": 2
}

Response samples

Content type
application/json
{
  • "success": true
}

Cancel Subscription

Info for a specific subscription

Authorizations:
ApiKeyAuth
path Parameters
subscriptionId
required
string

The id of the subscription to retrieve

Request Body schema: application/json
when
required
string
Default: "end-of-run"
Enum: "end-of-run" "instantly" "specific-date"
refund_type
required
string
Default: "none"
Enum: "none" "full" "prorate"
date
string <date>
comment
string or null

Responses

Request samples

Content type
application/json
{
  • "when": "end-of-run",
  • "refund_type": "none"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

Extend Trial Subscription

Extend a trial subscription so it's converted from a trial to a normal subscription.

Authorizations:
ApiKeyAuth
path Parameters
subscriptionId
required
string

The id of the subscription to retrieve

Request Body schema: application/json
price
required
uuid

Responses

Request samples

Content type
application/json
{
  • "price": null
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "seat_number": 1,
  • "schedule": "month",
  • "status": "string",
  • "created_at": "string",
  • "updated_at": "string",
  • "ended_at": "string",
  • "valid_until": "string",
  • "main_external_reference": "string",
  • "child_external_reference": "string",
  • "metadata": { },
  • "price": {
    },
  • "plan": {
    }
}

Change Subscription Plan

Change the subscription plan for a customer

Authorizations:
ApiKeyAuth
path Parameters
subscriptionId
required
string

The id of the subscription to retrieve

Request Body schema: application/json
when
required
string
Enum: "instantly" "next-cycle"
plan
required
string <uuid>

The ID for the subscription plan to be used

price
required
string <uuid>

The ID for the price to be used

Responses

Request samples

Content type
application/json
{
  • "when": "instantly",
  • "plan": "c685f150-7cb7-436f-9700-386be171480b",
  • "price": "296c3962-8fad-4bbf-a476-e2a5d4fe62a6"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "seat_number": 1,
  • "schedule": "month",
  • "status": "string",
  • "created_at": "string",
  • "updated_at": "string",
  • "ended_at": "string",
  • "valid_until": "string",
  • "main_external_reference": "string",
  • "child_external_reference": "string",
  • "metadata": { },
  • "price": {
    },
  • "plan": {
    }
}

Change Price

Changes the price being used for a price. Useful for changing pricing schedule or just price.

Authorizations:
ApiKeyAuth
path Parameters
subscriptionId
required
string

The id of the subscription to retrieve

Request Body schema: application/json
price
required
uuid
when
required
string
Enum: "next_cycle" "instantly"

Responses

Request samples

Content type
application/json
{
  • "price": null,
  • "when": "next_cycle"
}

Response samples

Content type
application/json
{
  • "success": true
}

Products

List

List all products

Authorizations:
ApiKeyAuth
query Parameters
limit
integer <int32>

How many items to return at one time (max 100)

last_key
string

The key to be used in pagination to say what the last key of the previous page was

name
string

The name to search for

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "has_more": true,
  • "last_key": "dc625535-d212-4c71-bf5c-662190b1b4de"
}

Create

Create a product

Authorizations:
ApiKeyAuth
Request Body schema: application/json
id
string <uuid>
name
required
string
external_reference
string or null

The reference given by the payment provider

object

Responses

Request samples

Content type
application/json
{
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

Detail

Info for a specific product

Authorizations:
ApiKeyAuth
path Parameters
productId
required
string

The id of the product to retrieve

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "external_reference": "string",
  • "tax_type": {
    }
}

Update

Update a product

Authorizations:
ApiKeyAuth
path Parameters
productId
required
string

The id of the product to retrieve

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "name": "string",
  • "external_reference": "string",
  • "tax_type": {
    }
}

Prices

List

List all prices

Authorizations:
ApiKeyAuth
path Parameters
productId
required
string

The id of the product to retrieve

query Parameters
limit
integer <int32>

How many items to return at one time (max 100)

last_key
string

The key to be used in pagination to say what the last key of the previous page was

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "has_more": true,
  • "last_key": "dc625535-d212-4c71-bf5c-662190b1b4de"
}

Create

Create a price

Authorizations:
ApiKeyAuth
path Parameters
productId
required
string

The id of the product to retrieve

Request Body schema: application/json
amount
required
integer
currency
required
string

Three-letter ISO currency code. Must be upper-case

external_reference
string or null
recurring
required
boolean
schedule
string or null
Enum: "week" "month" "year" "one-off"

Required if recurring is true

including_tax
boolean or null

If the price is including tax. If false tax will be added on top of the price.

public
boolean or null
object (Metric)

Responses

Request samples

Content type
application/json
{
  • "amount": 1000,
  • "currency": "EUR",
  • "recurring": false
}

Response samples

Content type
application/json
{
  • "code": 0,
  • "message": "string"
}

Checkout

Create Checkout

Create checkout

Since 2024.01

Authorizations:
ApiKeyAuth
Request Body schema: application/json
name
string
brand
required
string
slug
string
customer
required
string
Array of objects
Array of objects

Responses

Request samples

Content type
application/json
{
  • "brand": "string",
  • "customer": "string"
}

Response samples

Content type
application/json
{
  • "id": null,
  • "name": "string",
  • "currency": "string",
  • "customer": {
    },
  • "billing_admin": {
    },
  • "total": 0,
  • "sub_total": 0,
  • "tax_total": 0,
  • "lines": [
    ]
}

Receipt

Download Receipt

Returns the pdf blob for the Receipt

Authorizations:
ApiKeyAuth
path Parameters
receipt
required
string

The id of the receipt

Responses