A credit purchase was paid: deposits the credits on the entitlement's balance, once per reference.

POST

/api/v1/provision/admin/billing-events/credit-purchase-completed

curl --request POST \
  --url https://example.com/api/v1/provision/admin/billing-events/credit-purchase-completed \
  --header 'Content-Type: application/json' \
  --data '{ "externalReference": "example", "accountExternalReference": "example", "entitlementId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "metric": "example", "credits": 1 }'

Request Body^required

A paid one-time purchase of credits onto the balance of one of your entitlements. Deposited once per externalReference, however often it is posted.

object

externalReference

The purchase, e.g. chargebee:invoice:2034.

string

accountExternalReference

string

entitlementId

string format: uuid

metric

The balance-carrying metric the credits land on.

string

credits

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

Example^generated

{
  "externalReference": "example",
  "accountExternalReference": "example",
  "entitlementId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "metric": "example",
  "credits": 1
}

A paid one-time purchase of credits onto the balance of one of your entitlements. Deposited once per externalReference, however often it is posted.

object

externalReference

The purchase, e.g. chargebee:invoice:2034.

string

accountExternalReference

string

entitlementId

string format: uuid

metric

The balance-carrying metric the credits land on.

string

credits

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

Example^generated

{
  "externalReference": "example",
  "accountExternalReference": "example",
  "entitlementId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "metric": "example",
  "credits": 1
}

A paid one-time purchase of credits onto the balance of one of your entitlements. Deposited once per externalReference, however often it is posted.

object

externalReference

The purchase, e.g. chargebee:invoice:2034.

string

accountExternalReference

string

entitlementId

string format: uuid

metric

The balance-carrying metric the credits land on.

string

credits

number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

Example^generated

{
  "externalReference": "example",
  "accountExternalReference": "example",
  "entitlementId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "metric": "example",
  "credits": 1
}

Responses

202

Accepted

The event was accepted and published; its consumer applies it shortly after.

object

eventId

required

string format: uuid

The event was accepted and published; its consumer applies it shortly after.

object

eventId

required

string format: uuid

Example^generated

{
  "eventId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

The event was accepted and published; its consumer applies it shortly after.

object

eventId

required

string format: uuid

Example^generated

{
  "eventId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

400

Bad Request

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

401

Unauthorized

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

403

Forbidden

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

404

Not Found

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}