Credit Grants

API Reference

V1

Credit Grants

Credit Grants

Create a credit grant

v1.credit_grants.create(**kwargs) -> dataIDCreditGrantCreateResponse

post/v1/credits/createGrant

Update a credit grant

v1.credit_grants.edit(**kwargs) -> dataIDCreditGrantEditResponse

post/v1/credits/editGrant

List credit grants

v1.credit_grants.list(**kwargs) -> CursorPage<idStringbalanceobjectcustom_fieldshashcustomer_idStringdeductionsarrayeffective_atTimeexpires_atTimegrant_amountobjectnameStringpaid_amountobjectpending_deductionsarraypriorityFloatcredit_grant_typeStringinvoice_idStringproductsarrayreasonStringuniqueness_keyStringCreditGrantListResponse>

post/v1/credits/listGrants

List credit ledger entries

v1.credit_grants.list_entries(**kwargs) -> dataarraynext_pageStringCreditGrantListEntriesResponse

post/v1/credits/listEntries

Void a credit grant

v1.credit_grants.void(**kwargs) -> dataIDCreditGrantVoidResponse

post/v1/credits/voidGrant

Credit Ledger Entry

CreditLedgerEntryclass

ShowShow

amountFloat

an amount representing the change to the customer's credit balance

created_byString

credit_grant_idString

the credit grant this entry is related to

formatuuid

effective_atTime

formatdate-time

reasonString

running_balanceFloat

the running balance for this credit type at the time of the ledger entry, including all preceding charges

invoice_idString

optional

if this entry is a deduction, the Metronome ID of the invoice where the credit deduction was consumed; if this entry is a grant, the Metronome ID of the invoice where the grant's paid_amount was charged

formatuuid

Rollover Amount Max Amount

RolloverAmountMaxAmountclass

ShowShow

typeunion

:MAX_AMOUNT

Rollover up to a fixed amount of the original credit grant amount.

Hide ParametersShow Parameters

:MAX_AMOUNT

valueFloat

The maximum amount to rollover.

Rollover Amount Max Percentage

RolloverAmountMaxPercentageclass

ShowShow

typeunion

:MAX_PERCENTAGE

Rollover up to a percentage of the original credit grant amount.

Hide ParametersShow Parameters

:MAX_PERCENTAGE

valueFloat

The maximum percentage (0-1) of the original credit grant to rollover.

minimum0

maximum1