Get Points Expiry Schedule (Light API)

get

https://{host}/v2/customers/lookup/pointsExpirySchedule

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

source

string

enum

required

Source on which the identifier is available.

accountId

string

Account ID of a specific source if the source has multiple accounts.

identifierName

string

enum

required

Identifier type used to fetch the customer's expiry schedule details.

identifierValue

string

required

Identifier of the customer specific to the identifierName.

fetchDataForAllPrograms

boolean

Pass true to fetch points conversion schedules from all the available programs of the org.

fetchEarliestExpiryOnly

boolean

Pass true to fetche earliest points expiry records of default program or passed programId

startDate

string

Date (YYYY-MM-DD) from which points conversion schedule details need to be fetched. Default value - current time.

endDate

string

End date (YYYY-MM-DD) for the points conversion schedule details need to be fetched. Maximum supported date - current time + 100 years

programId

string

Unique ID of the program.

Responses

Language

Credentials

Basic

base64

URL

Loading…

Response

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

application/json

200200

400400