Skip to main content

Get Subscription

GET 
/subscriptions/:subscriptionId

Returns the details of a specific subscription based on the provided subscription ID.

info

The request must provide the following header: x-api-key: {merchantKey}

Request​

Path Parameters

    subscriptionId stringrequired

    Unique Identifier of the created Subscription. Format: Subscription + - + <UUID>

    Example: Subscription-caf9b798-315b-40aa-9659-cf732f55d847

Header Parameters

    Content-Type stringrequired

    Must be application/json

    Accept-Language stringrequired

    Must be be en-US

    Origin stringrequired

    The origin of the request

    User-Agent stringrequired

    The client making the request

    x-api-key stringrequired

    x-api-key: {merchantKey}

Responses​

Successful response

Schema

    id stringrequired

    Possible values: <= 100 characters

    Subscription ID automatically generated by the system.

    createdAt date-timerequired

    Possible values: <= 30 characters

    Timestamp of when the Subscription was created.

    updatedAt date-timerequired

    Possible values: <= 30 characters

    Timestamp of when the Subscription was last updated.

    deletedAt date-timenullable

    Possible values: <= 30 characters

    Timestamp of when the Subscription was deleted (if applicable).

    planId stringrequired

    Possible values: <= 100 characters

    Plan ID of the existing plan under which the Subscription was created.

    status stringrequired

    Possible values: <= 20 characters, [created, pending, trial, active, overdue, canceled, expired, paused]

    Status of the subscription.

    payment

    object

    required

    Payment details for the subscription.

    description stringrequired

    Possible values: <= 255 characters

    Description of the payment plan.

    recurrentAmount decimalrequired

    Possible values: <= 60 characters

    Amount to be charged per billing cycle.

    currencyIsoCode stringrequired

    Possible values: <= 3 characters

    Currency of the payment.

    startDate date-timerequired

    Possible values: <= 30 characters

    Start date of the subscription.

    timezone string

    Possible values: <= 32 characters

    TZ database name in List of TZ Database Time Zones.

    trialStartDate daterequired

    Possible values: <= 10 characters

    Start date of the trial period.

    trialEndDate daterequired

    Possible values: <= 10 characters

    End date of the trial period.

    nextBillingDate daterequired

    Possible values: <= 10 characters

    Next scheduled billing date.

    billingCyclesRemaining integerrequired

    Possible values: <= 2 characters

    Number of the remaining billing cycles to be charged. Populated initially from the input billingCycles of the parent subscription Plan. Every time a billing occurs (successful transaction) then the billingCyclesRemaining is reduced by 1.

    customerAccountId stringrequired

    Possible values: <= 125 characters

    Customer account associated with the subscription.

    merchantMetadata stringnullable

    Possible values: <= 255 characters

    Metadata provided by the merchant.

    externalMerchantId stringnullable

    Possible values: <= 255 characters

    External merchant identifier.

    billingAgreement

    object

    required

    Billing Agreement linked to the Subscription. Hosting the payment instrument information returned as null for newly created subscription.

    id stringrequired

    Possible values: <= 50 characters

    Unique Identifier of the Billing Agreement. Format: BillingAgreement + - + <UUID>

    paymentObjectId stringrequired

    PaymentObject used for billing this subscription.

    billingAgreementDate date-timerequired

    Possible values: <= 24 characters

    Date when the billing agreement was created.

    name stringrequired

    Possible values: <= 255 characters

    Display name of the payment option which has been stored.

    code stringrequired

    Possible values: <= 255 characters

    Code of the payment option which has been stored.

    carrierNumber string

    Masked carrier number of the payment instrument which has been stored.

    isExpired booleanrequired

    Possible values: [true, false]

    Indicates if a card used as a payment option is expired or not.

    expiryDate stringrequired

    Possible values: <= 7 characters, Value must match regular expression ^(0[1-9]|1[0-2])/[0-9]{4}$

    If a card is used as a payment option, this shows its expiry date.

    storedPaymentOptionData objectnullable

    Additional data related to the stored payment option.

    billingAddress

    object

    required

    Billing or shipping address of the consumer. Please refer to Data Model for details.

    addressLine1 stringrequired

    Possible values: <= 60 characters

    Address line 1.

    addressLine2 stringnullable

    Possible values: <= 60 characters

    Address line 2.

    addressLine3 stringnullable

    Possible values: <= 60 characters

    Address line 3.

    number stringrequired

    Possible values: <= 10 characters

    House number/building number.

    city stringrequired

    Possible values: <= 50 characters

    City name of the address.

    postCode stringrequired

    Possible values: <= 10 characters

    Postal code of the address.

    countryCode stringrequired

    Possible values: >= 2 characters and <= 3 characters

    Country code. Could be 2 or 3 characters depending on the format used. Format ISO 3166 ALPHA-2 or ISO 3166 ALPHA-3.

    state stringnullable

    Possible values: <= 3 characters

    State. Could be 2 or 3 characters depending on the state. This field is mandatory when the countryCode is US, USA, CA or CAN.

    shippingAddress

    object

    required

    Billing or shipping address of the consumer. Please refer to Data Model for details.

    addressLine1 stringrequired

    Possible values: <= 60 characters

    Address line 1.

    addressLine2 stringnullable

    Possible values: <= 60 characters

    Address line 2.

    addressLine3 stringnullable

    Possible values: <= 60 characters

    Address line 3.

    number stringrequired

    Possible values: <= 10 characters

    House number/building number.

    city stringrequired

    Possible values: <= 50 characters

    City name of the address.

    postCode stringrequired

    Possible values: <= 10 characters

    Postal code of the address.

    countryCode stringrequired

    Possible values: >= 2 characters and <= 3 characters

    Country code. Could be 2 or 3 characters depending on the format used. Format ISO 3166 ALPHA-2 or ISO 3166 ALPHA-3.

    state stringnullable

    Possible values: <= 3 characters

    State. Could be 2 or 3 characters depending on the state. This field is mandatory when the countryCode is US, USA, CA or CAN.

    consumer

    object

    required

    Consumer's personal data, in case the consumer is a physical person. See consumer in Data model.
    Conditional. Can be present if businessConsumer is missing from the request.

    firstName stringrequired

    Possible values: <= 60 characters

    First name of the consumer.

    lastName stringrequired

    Possible values: <= 60 characters

    Last name of the consumer.

    middleName stringnullable

    Possible values: <= 60 characters

    Middle name of the consumer.

    emailAddress emailrequired

    Possible values: <= 255 characters

    Email address of the customer.

    title stringrequired

    Possible values: <= 3 characters, [Mr, Mrs, Ms]

    Title of the consumer.

    culture string

    Possible values: <= 5 characters

    Consists of ISO 639-1 language code and ISO 3166-1 alpha-2 country code separated by dash. If this value is not provided the browser culture is used. Default culture is English (e.g.,, en-de). This field is not case sensitive.

    dateOfBirth daterequired

    Date of birth. Dummy data acceptable. Format “YYYY-MM-DD”.

    gender string

    Possible values: [M, F, D]

    Gender of the consumer.

    mobilePhone string

    Possible values: <= 30 characters

    Mobile phone of the customer.

    homePhone string

    Possible values: <= 30 characters

    Home phone of the customer.

    workPhone string

    Possible values: <= 30 characters

    Work phone of the customer.

    taxId stringnullable

    Possible values: <= 30 characters

    Tax ID of the consumer.

    businessConsumer

    object

    nullable

    required

    Company data, in case the consumer is a business or a legal entity. See businessConsumer in Data model.
    Conditional. Can be present if consumer is missing from the request.

    companyName stringrequired

    Possible values: <= 100 characters

    Company legal entity name.

    companyType stringrequired

    Possible values: <= 100 characters

    Company legal entity type (e.g., GmbH).

    emailAddress stringrequired

    Possible values: <= 255 characters

    Customer's email address.

    taxId stringnullable

    Possible values: <= 30 characters

    Tax identification number.

    culture stringnullable

    Possible values: <= 5 characters

    Consists of ISO 639-1 language code and ISO 3166-1 alpha-2 country code separated by dash. If this value is not provided the browser culture is used. Default culture is English (e.g.,, en-de). This field is not case sensitive.

    companyRegistrationNumber stringnullable

    Possible values: <= 50 characters

    Company registration number

    companyRegistrationCountryCode stringnullable

    Possible values: >= 2 characters and <= 3 characters

    ISO 3166-1 alpha-2 or ISO 3166-1 alpha-3 code of the address country.

    pausePeriodDays integernullable

    Number of days the subscription is paused.

    billingNotificationDate date-timenullable

    Possible values: <= 30 characters

    Date of the last billing notification.

    scheduledBillingCyclesRemaining integernullable

    Possible values: <= 2 characters

    Number of scheduled billing cycles remaining.

    scheduledAmount decimalnullable

    Scheduled amount for upcoming billing.

    pendingPayments booleannullable

    Indicates if there are pending payments.

    actionRequired booleannullable

    Indicates if any action is required from the merchant or customer.

    extraInfo objectnullable

    Additional information related to the subscription.

    customReferences objectnullable

    Custom references associated with the subscription.

    criteria

    object[]

    nullable

    An array of key-value pair objects. Please refer to Data Model for details.

  • Array [

    • name string
    value string

  • ]

    • targetMerchantAccountReference stringnullable

    Possible values: <= 100 characters

    Target merchant account reference if applicable.

Loading...
 Imprint
|
Data protection and privacy
© 2025 J.P. Morgan Mobility Payments Systems GmbH. All rights reserved.