Billing

Get the details of the billing configuration that the client is currently on.

get/billing-configuration

Request

  • Base URL: https://apigateway.jpmorgan.com/tsapi/ef/v1
  • URL: https://apigateway.jpmorgan.com/tsapi/ef/v1/billing-configuration
  • Auth: none declared

Headers

tokenstring

JWT Client token

Response

The details of the current billing configuration the client is on.

type'SUBSCRIPTION' | 'PAY_AS_YOU_GO' required

The type of billing the client is currently using.

currency'USD' required

The charge currency.

subscriptionNamestring

The name of the subscription package if the client is on a subscription.

subscriptionChargenumber

The amount the client would be charged on the billing day if they are on a subscription.

nextBillingDatestring date

The date that the client will next be billed on if they are on a subscription.

periodType'MONTHLY' | 'YEARLY'

The period when the client would be billed if they are on a subscription.

billingMonth'JANUARY' | 'FEBRUARY' | 'MARCH' | 'APRIL' | 'MAY' | 'JUNE' | 'JULY' | 'AUGUST' | 'SEPTEMBER' | 'OCTOBER' | 'NOVEMBER' | 'DECEMBER'

The month in which the client will be billed if they are on an yearly subscription.

billingDayinteger

The day the client would be billed on if they are on a subcription.

Example response

{
  "type": "SUBSCRIPTION",
  "currency": "USD",
  "subscriptionName": "Golden subscription",
  "subscriptionCharge": 30.25,
  "nextBillingDate": "2028-11-20",
  "billingMonth": "JANUARY",
  "billingDay": 25,
  "items": [
    {
      "billingEventType": "TRANSACTION",
      "billingEventSubType": "RTP_PAYOUT",
      "allowance": 5,
      "usage": 3,
      "calculationType": "PERCENTAGE",
      "flatCharge": 3.99,
      "percentageValue": 0.35,
      "minCharge": 2.45,
      "maxCharge": 5.5,
      "effectiveDateFrom": "1999-12-30",
      "effectiveDateTo": "2000-12-31"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.