Get a billing cycle by code

GET 
/api/gateway/v1/settlement/billing-cycles/:code

Get a billing cycle by code

Request

Path Parameters

code stringrequired

Billing cycle code

Header Parameters

x-api-key stringrequired

Gateway API key

Responses

200

Billing cycle with user charges

application/json

Schema

Schema

status numberrequired

Response status code

message stringrequired

Response status message

data

object

required

Response data

code stringrequired

Billing cycle code

description string

Description of the billing cycle

billingFrom date-timerequired

Start date of billing period

billingTo date-timerequired

End date of billing period

status stringrequired

Possible values: [INIT, IN_PROGRESS, FINALIZED, PENDING, CANCELLED]

Status of the billing cycle

totalAmount objectrequired

Total amount of charges in this billing cycle

totalPaid objectrequired

Total amount paid in this billing cycle

totalUnPaid objectrequired

Total amount unpaid in this billing cycle

createdAt date-time

Creation date

requestId string

Request ID for tracking

Example (from schema)

{
  "status": 200,
  "message": "OK",
  "data": {
    "code": "BC-2023-10",
    "description": "Monthly billing cycle for October 2023",
    "billingFrom": "2023-10-01T00:00:00Z",
    "billingTo": "2023-10-31T23:59:59Z",
    "status": "ACTIVE",
    "totalAmount": 50000,
    "totalPaid": 45000,
    "totalUnPaid": 5000,
    "createdAt": "2023-10-01T00:00:00Z"
  },
  "requestId": "req-123456"
}

401

Unauthorized

application/json

Schema

Schema

status number
message string

error

object

code string

Error code

detail string

Error detail

Example (from schema)

{
  "status": 401,
  "message": "Invalid API key",
  "error": {
    "code": "UNAUTHORIZED",
    "detail": "Invalid API key"
  }
}

404

Billing cycle not found

Loading...