Skip to main content
POST
Grant or Revoke Currency Credit

Authorizations

Authorization
string
header
required

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

Path Parameters

ID
string
required

The id or the vid of the Subscription A unique identifier. Optionally, this object can also be identified by its vid. Using a unique custom identifier is strongly encouraged.

Maximum string length: 128

Body

application/json

JSON - A (new) Currency Amount sub-resource. The Currency Amount object represents the change in the Currency Credit.

The CurrencyAmount object represents the currency credit detail associated with a particular grant of currency credits.

object
enum<string>

Value is “CurrencyAmount”

Available options:
CurrencyAmount
vid
string

A Globally Unique Identifier (GUID) for this object. This value is generated by Vindicia.

Maximum string length: 128
currency
string

An ISO 4217 Currency Code.

amount
number

The currency amount of the credit.

metadata
object

Metadata are sets of key-value pairs and are useful for storing additional, structured information on an object. This object is used to store a list of keys, which you create and associate with text string values. You use these key-value pairs to store custom data for your own internal tracking purposes, or to store CashBox specific data for defined CashBox purposes.

The metadata field supports key-value pairs with the following limitations:

Keys can be up to 256 characters

Keys can be any string that is needed, except only CashBox can prefix keys with vin:

Values can be up to 1024 characters

In some cases metadata from one object will be inherited automatically from one object to another that is spawned from it. e.g. metadata on a Subscription and SubscriptionItem will be inherited by all Transactions and TransactionItems that result from them.

sort_value
integer

Order of precedence value.

description
string

Text provided upon credit grant.

reason
string

Text provided upon credit grant.

granted_by_cashbox
boolean
granted
string<datetime>

The date and time the credit was originally granted.

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

Response

JSON - A (new) Currency Amount sub-resource.

The CurrencyAmount object represents the currency credit detail associated with a particular grant of currency credits.

object
enum<string>

Value is “CurrencyAmount”

Available options:
CurrencyAmount
vid
string

A Globally Unique Identifier (GUID) for this object. This value is generated by Vindicia.

Maximum string length: 128
currency
string

An ISO 4217 Currency Code.

amount
number

The currency amount of the credit.

metadata
object

Metadata are sets of key-value pairs and are useful for storing additional, structured information on an object. This object is used to store a list of keys, which you create and associate with text string values. You use these key-value pairs to store custom data for your own internal tracking purposes, or to store CashBox specific data for defined CashBox purposes.

The metadata field supports key-value pairs with the following limitations:

Keys can be up to 256 characters

Keys can be any string that is needed, except only CashBox can prefix keys with vin:

Values can be up to 1024 characters

In some cases metadata from one object will be inherited automatically from one object to another that is spawned from it. e.g. metadata on a Subscription and SubscriptionItem will be inherited by all Transactions and TransactionItems that result from them.

sort_value
integer

Order of precedence value.

description
string

Text provided upon credit grant.

reason
string

Text provided upon credit grant.

granted_by_cashbox
boolean
granted
string<datetime>

The date and time the credit was originally granted.

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