Skip to main content
POST
Create an Entitlement

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json

JSON - A new or existing Entitlement.

The entitlement object represents the services to which a customer is entitled. Entitlement can reside at the Account (granted directly to the Customer) or the Subscription level (granted due to purchase or presence of an active subscription).

object
enum<string>

Value is “Entitlement”

Available options:
Entitlement
id
string

A CSP-specified unique identifier.

description
string

The CSP-specified description of the entitled service.

account
object

The Account represents a merchant’s customer. As such it can contain as much or as little information as you collect about the customers (people or organizations) to which you offer billing and subscriptions. Subscriptions and Transactions must belong to an Account - as such, Accounts will be required in CashBox for billing. Read More in our User Guide

An Account can have any number of children accounts and may have up to one parent account. Read more in our User Guide.

An Account owns the “on file” payment methods to be used by it in billing.

subscription
object
billing_plan
object
subscription_item
object
product
object

The Product object represents a unique CSP product, with its own pricing, description and entitlement assignments. The API allows you to create, fetch, and update products. You can retrieve individual Product objects, as well as a list of all.

starts
string<datetime>

The date/time at which entitlement did or will begin.

ends
string<datetime>

The date/time at which entitlement did or will end.

active
boolean

Indicates whether this Entitlement is currently active.

Response

JSON A full Entitlement object.

The entitlement object represents the services to which a customer is entitled. Entitlement can reside at the Account (granted directly to the Customer) or the Subscription level (granted due to purchase or presence of an active subscription).

object
enum<string>

Value is “Entitlement”

Available options:
Entitlement
id
string

A CSP-specified unique identifier.

description
string

The CSP-specified description of the entitled service.

account
object

The Account represents a merchant’s customer. As such it can contain as much or as little information as you collect about the customers (people or organizations) to which you offer billing and subscriptions. Subscriptions and Transactions must belong to an Account - as such, Accounts will be required in CashBox for billing. Read More in our User Guide

An Account can have any number of children accounts and may have up to one parent account. Read more in our User Guide.

An Account owns the “on file” payment methods to be used by it in billing.

subscription
object
billing_plan
object
subscription_item
object
product
object

The Product object represents a unique CSP product, with its own pricing, description and entitlement assignments. The API allows you to create, fetch, and update products. You can retrieve individual Product objects, as well as a list of all.

starts
string<datetime>

The date/time at which entitlement did or will begin.

ends
string<datetime>

The date/time at which entitlement did or will end.

active
boolean

Indicates whether this Entitlement is currently active.