Create a credit

post

https://api.monetizeplatform.com/api/accounts/{accountId}/billGroups/{billGroupId}/credits

Create a credit which can be used to adjust account balance

Path Params

accountId

string

required

billGroupId

string

required

Body Params

creditNoteId

string

ID for the Note of this credit

prepaidInvoiceItemId

string

Invoice item id for prepaid invoice

prepaidProductId

string

Id for prepaid product

status

string

enum

Status of the credit. Describes if it can be ACTIVE,INACTIVE,CANCELED or APPLIED

Allowed:

type

string

enum

Type of the credit. Can be CREDIT_NOTE,SERVICE,PREPAID

Allowed:

currency

string

enum

Currency for the credit amount

amount

number

Amount which can be applied

expirationDate

date

Expiration date for this credit

reason

string

length between 0 and 255

Reason why this credit exists/created

name

string

Name of the credit

customFields

object

User configured custom fields for the credit

Headers

x-api-key

string

required

x-api-key is an authentication or authorization token used in API requests to verify the identity and permissions of the client

Responses

Language

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Credit saved successfully.

400Bad Request

500Internal server error. Please contact the support team.