v1

latestOpenAPI 3.0.12026-07-26381328555.2 KB

Credit

Get credit

Get credit specified by code.

get/commerce/customer/credits/{code}

Path parameters

codestring required

Query parameters

responseFieldsstring

limits which fields are returned in the response body

Response

activationDatestring date-time nullable

Date the credit was activated. Null if card is not active. Credits must be activated before they can be used. ReadOnly after activation

codestring nullable

Unique number identifier representing this credit. Number may be generated or set by the Tenant Number is unique within the Tenant context. ReadOnly after credit creation

creditTypestring nullable

Type of Credit. Mozu.Customer.Contracts.Credit.Credit.CreditTypeConst Required. ReadOnly after credit creation

creditTypeIdinteger

currencyCodestring nullable

Currency Code

currentBalancenumber double nullable

Do we want to track this here? Current Balance ReadOnly

customCreditTypestring nullable

Name of custom credit type Optional.

customerIdinteger nullable

Id of the N:Mozu.Customer that this credit is assigned to. Optional.

expirationDatestring date-time nullable

Date after which this credit is no longer valid Optional Defaults to 365 days

initialBalancenumber double nullable

Balance assigned when credit was initially created. May be zero and updated later. ReadOnly after intial credit creation