SBC11 - List seller billing cycles

Request

Description

This resource uses seek pagination. The maximum allowed value for parameter limit is 1000.

Call Frequency

Recommended usage: Once per day and as many times as there are billing cycle pages returned

Maximum usage: Once per day and as many times as there are billing cycle pages returned

Pagination

This resource supports seek pagination (see documentation)

Sort fields

sort field can have the following values:

dateCreated (Default) - Sort by creation date (asc by default)

Security

Shop-API-Key(Required scopes: ROLE_SHOP_ADMIN)

Query

currencyArray of strings

Currency for filtering. This parameter can be supplied multiple times.

Items Enum:"AED""ARS""AUD""BAM""BGN""BHD""BRL""CAD""CHF""CLP"

end_datestring, (date-time)

Creation date used as the maximum value for filtering (inclusive)

idArray of strings, <= 100 items

Seller billing cycle IDs for filtering. This parameter can be supplied multiple times.

pay_out_psp_codeArray of strings

A comma-separated list of pay-out PSP codes for filtering. This parameter requires the Hybrid pay-out PSP feature to be enabled.

Items Enum:"NOT_SPECIFIED""MANGOPAY""MIRAKL_PAYOUT""OPERATOR"

pay_out_stateArray of strings

Pay-out state for filtering. This parameter can be supplied multiple times.

Default:["TO_PAY","FAILED","PAID"]

start_datestring, (date-time)

Creation date used as the minimum value for filtering (inclusive)

shop_idinteger, (int64)

Use this parameter when your user has access to several shops. If not specified, the shop_id from your default shop will be used.

curl -i -X GET \
  'https://your-instance.mirakl.net/api/seller-billing-cycles?currency=AED&end_date=2019-08-24T14%3A15%3A22Z&id=stringstringstringstringstringstring&pay_out_psp_code=NOT_SPECIFIED&pay_out_state=TO_PAY%2CFAILED%2CPAID&start_date=2019-08-24T14%3A15%3A22Z&shop_id=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json

dataArray of objectsrequired

Page of data

next_page_tokenstring

Token to access the next page. Absent if the current page is the last one.

previous_page_tokenstring

Token to access the previous page. Absent if the current page is the first one.

Response

{
  "data": [
    { … },
    { … },
    { … }
  ]
}