Get a plan

curl --request POST \
  --url https://sandbox-platform.jupico.com/v1/query/subscriptions/plan/{planId} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{}'

import requests

url = "https://sandbox-platform.jupico.com/v1/query/subscriptions/plan/{planId}"

payload = {}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({})
};

fetch('https://sandbox-platform.jupico.com/v1/query/subscriptions/plan/{planId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

const url = 'https://sandbox-platform.jupico.com/v1/query/subscriptions/plan/{planId}';
const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({})
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

{
  "success": true,
  "data": {
    "plan": {
      "_id": "<string>",
      "facId": "<string>",
      "spProductId": "<string>",
      "subMerchantId": "<string>",
      "planId": "<string>",
      "hostedSession": {
        "hostedSessionId": "<string>",
        "url": "<string>"
      },
      "name": "<string>",
      "description": "<string>",
      "title": "<string>",
      "subTitle": "<string>",
      "schedules": [
        {
          "scheduleId": "<string>",
          "order": 123,
          "label": "<string>",
          "invoiceDescription": "<string>",
          "frequency": "<string>",
          "cyclesQty": 123,
          "executionDays": [
            123
          ],
          "unit": "<string>",
          "discount": {
            "percentage": 123
          },
          "pricingModel": {
            "type": "<string>",
            "free": {
              "daysQty": 123
            }
          },
          "enabled": true
        }
      ],
      "cancelOptions": [
        "<string>"
      ],
      "status": "<string>",
      "isDeleted": true,
      "__v": 123,
      "createdAt": "<string>",
      "updatedAt": "<string>"
    },
    "subMerchant": {
      "_id": "<string>",
      "facId": "<string>",
      "spProductId": "<string>",
      "subMerchantId": "<string>",
      "status": "<string>",
      "blockDuplicates": {
        "enabled": true
      },
      "transactionAmountLimit": 123,
      "eCheckAmountLimit": 123,
      "fees": {
        "platform": {
          "perTransaction": {},
          "perPeriod": [
            {
              "period": "daily",
              "fixed": 3,
              "since": "2025-08-01T03:00:00.000Z",
              "until": "2025-08-23T03:00:00.000Z",
              "status": "enabled",
              "isTriggerFirstTx": false,
              "isProrated": true
            }
          ]
        },
        "spProduct": {
          "perTransaction": {},
          "perPeriod": [
            "<string>"
          ],
          "perIncident": [
            "<string>"
          ]
        }
      },
      "reserve": {
        "enabled": true,
        "cap": 123,
        "percentage": 123
      },
      "payout": {
        "mode": "<string>",
        "frequency": "<string>",
        "executionDays": [
          123
        ]
      },
      "subMerchantApplicationId": "<string>",
      "payoutBankAccounts": [
        {
          "accountRouting": "<string>",
          "accountNumber": "<string>",
          "accountType": "<string>",
          "entityType": "<string>",
          "nameOnAccount": "<string>",
          "status": "<string>",
          "isPreferred": true,
          "processor": {
            "stripe": {
              "status": "<string>"
            }
          },
          "bankAccountToken": "<string>",
          "isDeleted": true
        }
      ],
      "email": "<string>",
      "mobileNumber": "<string>",
      "processor": {
        "type": "<string>",
        "simulator": {
          "merchantId": "<string>",
          "status": "<string>"
        },
        "cybersource": {
          "enabled": true
        },
        "fiserv": {
          "url": [
            "<string>"
          ]
        },
        "stripe": {
          "owners": [
            "<string>"
          ]
        }
      },
      "identity": {
        "business": {
          "legalName": "<string>",
          "dbaName": "<string>",
          "tinType": "<string>",
          "federalTaxId": "<string>",
          "phoneNumber": "<string>",
          "address": {
            "streetNum": "<string>",
            "streetName": "<string>",
            "city": "<string>",
            "state": "<string>",
            "postalCode": "<string>",
            "country": "<string>",
            "type": "<string>"
          },
          "websiteUrl": "<string>",
          "ownershipType": "<string>",
          "businessEstablishedDate": "<string>",
          "expectedMonthlyVolume": 123,
          "mccCode": "<string>",
          "businessType": "<string>",
          "irsStatus": "<string>"
        },
        "contacts": [
          {
            "firstName": "<string>",
            "lastName": "<string>",
            "email": "<string>",
            "phoneNumber": "<string>",
            "ssn": "<string>",
            "birthDate": "<string>",
            "position": "<string>",
            "_id": "<string>"
          }
        ],
        "acceptedCards": [
          {
            "type": "<string>"
          }
        ]
      },
      "progress": {
        "isStartApplication": true,
        "isCompleteProfile": true,
        "isSubmit": true
      },
      "rules": {
        "knowYourBusiness": {
          "passed": true,
          "checksIds": [
            "<string>"
          ]
        },
        "payoutBankAccount": {
          "passed": true,
          "checksIds": [
            "<string>"
          ]
        },
        "uniqueLocation": {
          "passed": true,
          "checksIds": [
            "<string>"
          ]
        },
        "acknowledged": {
          "passed": true,
          "checksIds": [
            "<string>"
          ]
        },
        "merchantMonitoring": {
          "passed": true,
          "checksIds": [
            "<string>"
          ],
          "score": 123
        }
      },
      "tokenization": {
        "publicKey": "<string>"
      },
      "settings": {
        "branding": {
          "primaryColor": "<string>",
          "secondaryColor": "<string>",
          "backgroundColor": "<string>",
          "contrastColor": "<string>",
          "textColor": "<string>"
        },
        "hostedSession": {
          "functions": {
            "collectBillingAddress": {
              "enabled": true
            },
            "collectShippingAddress": {
              "enabled": true
            },
            "collectEmail": {
              "enabled": true,
              "updateCustomer": true
            },
            "collectPhoneNumber": {
              "enabled": true
            },
            "notes": {
              "enabled": true
            },
            "callToAction": {
              "enabled": true
            }
          },
          "paymentMethods": {
            "creditCard": {
              "enabled": true,
              "cards": [
                "<string>"
              ]
            },
            "eCheck": {
              "enabled": true,
              "accounts": [
                "<string>"
              ]
            },
            "applePay": {
              "enabled": true
            },
            "googlePay": {
              "enabled": true
            }
          }
        },
        "invoice": {
          "invoiceNumber": "<string>"
        }
      },
      "logs": [
        "<string>"
      ],
      "tags": [
        "<string>"
      ],
      "acknowledgedAt": "<string>",
      "validations": {
        "enabled": true,
        "avs": {
          "addressNumber": true,
          "addressPostalCode": true
        },
        "cvv": {
          "cvcCheck": true
        }
      },
      "createdAt": "<string>"
    }
  },
  "code": "<string>"
}

POST

https://sandbox-platform.jupico.com

query

subscriptions

plan

{planId}

Get a plan

curl --request POST \
  --url https://sandbox-platform.jupico.com/v1/query/subscriptions/plan/{planId} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{}'

import requests

url = "https://sandbox-platform.jupico.com/v1/query/subscriptions/plan/{planId}"

payload = {}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({})
};

fetch('https://sandbox-platform.jupico.com/v1/query/subscriptions/plan/{planId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

const url = 'https://sandbox-platform.jupico.com/v1/query/subscriptions/plan/{planId}';
const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({})
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

{
  "success": true,
  "data": {
    "plan": {
      "_id": "<string>",
      "facId": "<string>",
      "spProductId": "<string>",
      "subMerchantId": "<string>",
      "planId": "<string>",
      "hostedSession": {
        "hostedSessionId": "<string>",
        "url": "<string>"
      },
      "name": "<string>",
      "description": "<string>",
      "title": "<string>",
      "subTitle": "<string>",
      "schedules": [
        {
          "scheduleId": "<string>",
          "order": 123,
          "label": "<string>",
          "invoiceDescription": "<string>",
          "frequency": "<string>",
          "cyclesQty": 123,
          "executionDays": [
            123
          ],
          "unit": "<string>",
          "discount": {
            "percentage": 123
          },
          "pricingModel": {
            "type": "<string>",
            "free": {
              "daysQty": 123
            }
          },
          "enabled": true
        }
      ],
      "cancelOptions": [
        "<string>"
      ],
      "status": "<string>",
      "isDeleted": true,
      "__v": 123,
      "createdAt": "<string>",
      "updatedAt": "<string>"
    },
    "subMerchant": {
      "_id": "<string>",
      "facId": "<string>",
      "spProductId": "<string>",
      "subMerchantId": "<string>",
      "status": "<string>",
      "blockDuplicates": {
        "enabled": true
      },
      "transactionAmountLimit": 123,
      "eCheckAmountLimit": 123,
      "fees": {
        "platform": {
          "perTransaction": {},
          "perPeriod": [
            {
              "period": "daily",
              "fixed": 3,
              "since": "2025-08-01T03:00:00.000Z",
              "until": "2025-08-23T03:00:00.000Z",
              "status": "enabled",
              "isTriggerFirstTx": false,
              "isProrated": true
            }
          ]
        },
        "spProduct": {
          "perTransaction": {},
          "perPeriod": [
            "<string>"
          ],
          "perIncident": [
            "<string>"
          ]
        }
      },
      "reserve": {
        "enabled": true,
        "cap": 123,
        "percentage": 123
      },
      "payout": {
        "mode": "<string>",
        "frequency": "<string>",
        "executionDays": [
          123
        ]
      },
      "subMerchantApplicationId": "<string>",
      "payoutBankAccounts": [
        {
          "accountRouting": "<string>",
          "accountNumber": "<string>",
          "accountType": "<string>",
          "entityType": "<string>",
          "nameOnAccount": "<string>",
          "status": "<string>",
          "isPreferred": true,
          "processor": {
            "stripe": {
              "status": "<string>"
            }
          },
          "bankAccountToken": "<string>",
          "isDeleted": true
        }
      ],
      "email": "<string>",
      "mobileNumber": "<string>",
      "processor": {
        "type": "<string>",
        "simulator": {
          "merchantId": "<string>",
          "status": "<string>"
        },
        "cybersource": {
          "enabled": true
        },
        "fiserv": {
          "url": [
            "<string>"
          ]
        },
        "stripe": {
          "owners": [
            "<string>"
          ]
        }
      },
      "identity": {
        "business": {
          "legalName": "<string>",
          "dbaName": "<string>",
          "tinType": "<string>",
          "federalTaxId": "<string>",
          "phoneNumber": "<string>",
          "address": {
            "streetNum": "<string>",
            "streetName": "<string>",
            "city": "<string>",
            "state": "<string>",
            "postalCode": "<string>",
            "country": "<string>",
            "type": "<string>"
          },
          "websiteUrl": "<string>",
          "ownershipType": "<string>",
          "businessEstablishedDate": "<string>",
          "expectedMonthlyVolume": 123,
          "mccCode": "<string>",
          "businessType": "<string>",
          "irsStatus": "<string>"
        },
        "contacts": [
          {
            "firstName": "<string>",
            "lastName": "<string>",
            "email": "<string>",
            "phoneNumber": "<string>",
            "ssn": "<string>",
            "birthDate": "<string>",
            "position": "<string>",
            "_id": "<string>"
          }
        ],
        "acceptedCards": [
          {
            "type": "<string>"
          }
        ]
      },
      "progress": {
        "isStartApplication": true,
        "isCompleteProfile": true,
        "isSubmit": true
      },
      "rules": {
        "knowYourBusiness": {
          "passed": true,
          "checksIds": [
            "<string>"
          ]
        },
        "payoutBankAccount": {
          "passed": true,
          "checksIds": [
            "<string>"
          ]
        },
        "uniqueLocation": {
          "passed": true,
          "checksIds": [
            "<string>"
          ]
        },
        "acknowledged": {
          "passed": true,
          "checksIds": [
            "<string>"
          ]
        },
        "merchantMonitoring": {
          "passed": true,
          "checksIds": [
            "<string>"
          ],
          "score": 123
        }
      },
      "tokenization": {
        "publicKey": "<string>"
      },
      "settings": {
        "branding": {
          "primaryColor": "<string>",
          "secondaryColor": "<string>",
          "backgroundColor": "<string>",
          "contrastColor": "<string>",
          "textColor": "<string>"
        },
        "hostedSession": {
          "functions": {
            "collectBillingAddress": {
              "enabled": true
            },
            "collectShippingAddress": {
              "enabled": true
            },
            "collectEmail": {
              "enabled": true,
              "updateCustomer": true
            },
            "collectPhoneNumber": {
              "enabled": true
            },
            "notes": {
              "enabled": true
            },
            "callToAction": {
              "enabled": true
            }
          },
          "paymentMethods": {
            "creditCard": {
              "enabled": true,
              "cards": [
                "<string>"
              ]
            },
            "eCheck": {
              "enabled": true,
              "accounts": [
                "<string>"
              ]
            },
            "applePay": {
              "enabled": true
            },
            "googlePay": {
              "enabled": true
            }
          }
        },
        "invoice": {
          "invoiceNumber": "<string>"
        }
      },
      "logs": [
        "<string>"
      ],
      "tags": [
        "<string>"
      ],
      "acknowledgedAt": "<string>",
      "validations": {
        "enabled": true,
        "avs": {
          "addressNumber": true,
          "addressPostalCode": true
        },
        "cvv": {
          "cvcCheck": true
        }
      },
      "createdAt": "<string>"
    }
  },
  "code": "<string>"
}

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

planId

string

required

planID

Body

application/json

The body is of type object.

Response

200 - application/json

Find Plan By Id

success

boolean

Whether the request was processed successfully. Declines return HTTP 200 with success: false.

data

object

The response payload.

Hide child attributes

data.plan

object

The plan object.

Hide child attributes

data.plan._id

string

Internal document identifier.

data.plan.facId

string

Facilitator identifier assigned by Jupico.

data.plan.spProductId

string

Identifier of the Service Provider product the merchant belongs to.

data.plan.subMerchantId

string

Unique identifier of the submerchant.

data.plan.planId

string

Unique identifier of the subscription plan.

data.plan.hostedSession

object

Configuration for the hosted payment page.

Hide child attributes

data.plan.hostedSession.hostedSessionId

string

Identifier of the hosted session.

data.plan.hostedSession.url

string

URL of the hosted page for this object.

data.plan.name

string

Display name.

data.plan.description

string

Free-text description.

data.plan.title

string

Title.

data.plan.subTitle

string

Subtitle displayed under the plan title.

data.plan.schedules

object[]

Billing schedules for the plan.

Hide child attributes

data.plan.schedules.scheduleId

string

Identifier of the plan schedule the subscription uses.

data.plan.schedules.order

integer

Display order, starting at 1.

data.plan.schedules.label

string

Display label for this schedule.

data.plan.schedules.invoiceDescription

string

Description shown on invoices generated by this schedule.

data.plan.schedules.frequency

string

Billing frequency.

data.plan.schedules.cyclesQty

integer

Number of billing cycles before the schedule ends.

data.plan.schedules.executionDays

integer[]

Days on which scheduled charges execute.

data.plan.schedules.unit

string

Unit label for usage-based pricing.

data.plan.schedules.discount

object

Discount applied to the schedule.

Hide child attributes

data.plan.schedules.discount.percentage

integer

Discount percentage.

data.plan.schedules.pricingModel

object

Pricing model configuration for this schedule.

Hide child attributes

data.plan.schedules.pricingModel.type

string

The type.

data.plan.schedules.pricingModel.free

object

Free trial configuration.

Hide child attributes

data.plan.schedules.pricingModel.free.daysQty

integer

Number of free days before billing begins.

data.plan.schedules.enabled

boolean

Whether this setting is enabled.

data.plan.cancelOptions

string[]

Cancellation options offered to subscribers.

data.plan.status

string

Current status.

data.plan.isDeleted

boolean

Whether the record is soft-deleted.

data.plan.__v

integer

Internal document version. Ignore.

data.plan.createdAt

string

Timestamp when the object was created (ISO 8601).

data.plan.updatedAt

string

Timestamp when the object was last updated (ISO 8601).

data.subMerchant

object

The submerchant object.

Hide child attributes

data.subMerchant._id

string

Internal document identifier.

data.subMerchant.facId

string

Facilitator identifier assigned by Jupico.

data.subMerchant.spProductId

string

Identifier of the Service Provider product the merchant belongs to.

data.subMerchant.subMerchantId

string

Unique identifier of the submerchant.

data.subMerchant.status

string

Current status.

data.subMerchant.blockDuplicates

object

Duplicate-transaction blocking settings.

Hide child attributes

data.subMerchant.blockDuplicates.enabled

boolean

Whether this setting is enabled.

data.subMerchant.transactionAmountLimit

integer

Maximum amount per card transaction.

data.subMerchant.eCheckAmountLimit

integer

Maximum amount per eCheck transaction.

data.subMerchant.fees

object

Fee configuration. Overrides values from the fees template.

Hide child attributes

data.subMerchant.fees.platform

object

Fee configuration at the platform level.

Hide child attributes

data.subMerchant.fees.platform.perTransaction

object

Event-based fees, one entry per transaction event type.

Hide child attributes

data.subMerchant.fees.platform.perTransaction.{key}

object

Hide child attributes

data.subMerchant.fees.platform.perTransaction.{key}.discountRate

number

data.subMerchant.fees.platform.perTransaction.{key}.fixed

number

data.subMerchant.fees.platform.perTransaction.{key}.reverseFixed

boolean

data.subMerchant.fees.platform.perPeriod

object[]

Recurring fees charged on a fixed schedule, such as monthly service fees.

Hide child attributes

data.subMerchant.fees.platform.perPeriod.period

string

Billing period for this recurring fee.

Example:

"daily"

data.subMerchant.fees.platform.perPeriod.fixed

number

Fixed fee amount charged each time this event occurs.

Example:

3

data.subMerchant.fees.platform.perPeriod.since

string<date-time>

Start of the window during which this fee applies (ISO 8601).

Example:

"2025-08-01T03:00:00.000Z"

data.subMerchant.fees.platform.perPeriod.until

string<date-time>

End of the window during which this fee applies (ISO 8601).

Example:

"2025-08-23T03:00:00.000Z"

data.subMerchant.fees.platform.perPeriod.status

string

Whether this recurring fee is currently active.

Example:

"enabled"

data.subMerchant.fees.platform.perPeriod.isTriggerFirstTx

boolean

When true, the recurring fee starts only after the merchant processes their first transaction.

Example:

false

data.subMerchant.fees.platform.perPeriod.isProrated

boolean

Whether the first billing period is prorated.

Example:

true

data.subMerchant.fees.spProduct

object

Fee configuration at the Service Provider product level.

Hide child attributes

data.subMerchant.fees.spProduct.perTransaction

object

Event-based fees, one entry per transaction event type.

Hide child attributes

data.subMerchant.fees.spProduct.perTransaction.{key}

object

Hide child attributes

data.subMerchant.fees.spProduct.perTransaction.{key}.discountRate

number

data.subMerchant.fees.spProduct.perTransaction.{key}.fixed

number

data.subMerchant.fees.spProduct.perTransaction.{key}.reverseFixed

boolean

data.subMerchant.fees.spProduct.perPeriod

string[]

Recurring fees charged on a fixed schedule, such as monthly service fees.

data.subMerchant.fees.spProduct.perIncident

string[]

Fees charged per incident.

data.subMerchant.reserve

object

Reserve configuration.

Hide child attributes

data.subMerchant.reserve.enabled

boolean

Whether this setting is enabled.

data.subMerchant.reserve.cap

integer

Reserve cap amount.

data.subMerchant.reserve.percentage

integer

Discount percentage.

data.subMerchant.payout

object

Payout configuration.

Hide child attributes

data.subMerchant.payout.mode

string

Payout mode.

data.subMerchant.payout.frequency

string

Billing frequency.

data.subMerchant.payout.executionDays

integer[]

Days on which scheduled charges execute.

data.subMerchant.subMerchantApplicationId

string

Identifier of the merchant application.

data.subMerchant.payoutBankAccounts

object[]

Bank accounts where the merchant receives payouts.

Hide child attributes

data.subMerchant.payoutBankAccounts.accountRouting

string

9-digit ABA routing number.

data.subMerchant.payoutBankAccounts.accountNumber

string

Bank account number.

data.subMerchant.payoutBankAccounts.accountType

string

Bank account type, such as checking.

data.subMerchant.payoutBankAccounts.entityType

string

Entity type of the account holder.

data.subMerchant.payoutBankAccounts.nameOnAccount

string

Name on the bank account.

data.subMerchant.payoutBankAccounts.status

string

Current status.

data.subMerchant.payoutBankAccounts.isPreferred

boolean

Whether this is the preferred account for payouts.

data.subMerchant.payoutBankAccounts.processor

object

Processor configuration.

Hide child attributes

data.subMerchant.payoutBankAccounts.processor.stripe

object

Stripe processor configuration.

Hide child attributes

data.subMerchant.payoutBankAccounts.processor.stripe.status

string

Current status.

data.subMerchant.payoutBankAccounts.bankAccountToken

string

Token of the bank account that receives the payout.

data.subMerchant.payoutBankAccounts.isDeleted

boolean

Whether the record is soft-deleted.

data.subMerchant.email

string

Email address.

data.subMerchant.mobileNumber

string

Mobile number (numeric only).

data.subMerchant.processor

object

Processor configuration.

Hide child attributes

data.subMerchant.processor.type

string

The type.

data.subMerchant.processor.simulator

object

Simulator processor configuration (Sandbox).

Hide child attributes

data.subMerchant.processor.simulator.merchantId

string

Merchant identifier at the processor.

data.subMerchant.processor.simulator.status

string

Current status.

data.subMerchant.processor.cybersource

object

CyberSource processor configuration.

Hide child attributes

data.subMerchant.processor.cybersource.enabled

boolean

Whether this setting is enabled.

data.subMerchant.processor.fiserv

object

Fiserv processor configuration.

Hide child attributes

data.subMerchant.processor.fiserv.url

string[]

URL of the hosted page for this object.

data.subMerchant.processor.stripe

object

Stripe processor configuration.

Hide child attributes

data.subMerchant.processor.stripe.owners

string[]

Business owners.

data.subMerchant.identity

object

Identity details for the business and its owners.

Hide child attributes

data.subMerchant.identity.business

object

Business identity details.

Hide child attributes

data.subMerchant.identity.business.legalName

string

Registered legal name of the business.

data.subMerchant.identity.business.dbaName

string

The merchant's doing-business-as name. Appears on customer statements unless overridden.

data.subMerchant.identity.business.tinType

string

Type of tax identification number: SSN, EIN, or Other.

data.subMerchant.identity.business.federalTaxId

string

Federal tax ID, 9 digits.

data.subMerchant.identity.business.phoneNumber

string

Business phone number.

data.subMerchant.identity.business.address

object

Registered business address.

Hide child attributes

data.subMerchant.identity.business.address.streetNum

string

Street number.

data.subMerchant.identity.business.address.streetName

string

Street name.

data.subMerchant.identity.business.address.city

string

City name.

data.subMerchant.identity.business.address.state

string

Two-letter US state code.

data.subMerchant.identity.business.address.postalCode

string

ZIP or postal code.

data.subMerchant.identity.business.address.country

string

Two-letter ISO country code.

data.subMerchant.identity.business.address.type

string

The type.

data.subMerchant.identity.business.websiteUrl

string

Business website URL.

data.subMerchant.identity.business.ownershipType

string

Legal structure of the business.

data.subMerchant.identity.business.businessEstablishedDate

string

Date the business was established (YYYY-MM-DD).

data.subMerchant.identity.business.expectedMonthlyVolume

integer

Expected monthly processing volume, used in underwriting.

data.subMerchant.identity.business.mccCode

string

Four-digit merchant category code (MCC) that classifies the business.

data.subMerchant.identity.business.businessType

string

Business type classification.

data.subMerchant.identity.business.irsStatus

string

IRS TIN-matching status.

data.subMerchant.identity.contacts

object[]

Contacts for the business.

Hide child attributes

data.subMerchant.identity.contacts.firstName

string

First name.

data.subMerchant.identity.contacts.lastName

string

Last name.

data.subMerchant.identity.contacts.email

string

Email address.

data.subMerchant.identity.contacts.phoneNumber

string

Phone number.

data.subMerchant.identity.contacts.ssn

string

Social Security number, 9 digits.

data.subMerchant.identity.contacts.birthDate

string

Date of birth (YYYY-MM-DD).

data.subMerchant.identity.contacts.position

string

Role of the owner in the business.

data.subMerchant.identity.contacts._id

string

Internal document identifier.

data.subMerchant.identity.acceptedCards

object[]

Card brands the merchant accepts.

Hide child attributes

data.subMerchant.identity.acceptedCards.type

string

The type.

data.subMerchant.progress

object

Onboarding progress flags.

Hide child attributes

data.subMerchant.progress.isStartApplication

boolean

Whether the merchant started the application.

data.subMerchant.progress.isCompleteProfile

boolean

Whether the merchant completed their profile.

data.subMerchant.progress.isSubmit

boolean

Whether the merchant submitted the application.

data.subMerchant.rules

object

Risk and compliance rule results.

Hide child attributes

data.subMerchant.rules.knowYourBusiness

object

Know Your Business (KYB) verification results.

Hide child attributes

data.subMerchant.rules.knowYourBusiness.passed

boolean

Whether the check passed.

data.subMerchant.rules.knowYourBusiness.checksIds

string[]

Identifiers of the verification checks performed.

data.subMerchant.rules.payoutBankAccount

object

Payout bank account verification result.

Hide child attributes

data.subMerchant.rules.payoutBankAccount.passed

boolean

Whether the check passed.

data.subMerchant.rules.payoutBankAccount.checksIds

string[]

Identifiers of the verification checks performed.

data.subMerchant.rules.uniqueLocation

object

Unique-location verification result.

Hide child attributes

data.subMerchant.rules.uniqueLocation.passed

boolean

Whether the check passed.

data.subMerchant.rules.uniqueLocation.checksIds

string[]

Identifiers of the verification checks performed.

data.subMerchant.rules.acknowledged

object

Acknowledgement state of merchant agreements.

Hide child attributes

data.subMerchant.rules.acknowledged.passed

boolean

Whether the check passed.

data.subMerchant.rules.acknowledged.checksIds

string[]

Identifiers of the verification checks performed.

data.subMerchant.rules.merchantMonitoring

object

Merchant monitoring results.

Hide child attributes

data.subMerchant.rules.merchantMonitoring.passed

boolean

Whether the check passed.

data.subMerchant.rules.merchantMonitoring.checksIds

string[]

Identifiers of the verification checks performed.

data.subMerchant.rules.merchantMonitoring.score

integer

Monitoring risk score.

data.subMerchant.tokenization

object

Tokenization configuration.

Hide child attributes

data.subMerchant.tokenization.publicKey

string

Public key used for tokenization.

data.subMerchant.settings

object

Merchant settings.

Hide child attributes

data.subMerchant.settings.branding

object

Brand colors and logo for the hosted page.

Hide child attributes

data.subMerchant.settings.branding.primaryColor

string

Primary color (hex).

data.subMerchant.settings.branding.secondaryColor

string

Secondary color (hex).

data.subMerchant.settings.branding.backgroundColor

string

Background color (hex).

data.subMerchant.settings.branding.contrastColor

string

Contrast color (hex).

data.subMerchant.settings.branding.textColor

string

Text color (hex).

data.subMerchant.settings.hostedSession

object

Configuration for the hosted payment page.

Hide child attributes

data.subMerchant.settings.hostedSession.functions

object

Data-collection and display options for the hosted page.

Hide child attributes

data.subMerchant.settings.hostedSession.functions.collectBillingAddress

object

Collect the customer's billing address during checkout.

Hide child attributes

data.subMerchant.settings.hostedSession.functions.collectBillingAddress.enabled

boolean

Whether this setting is enabled.

data.subMerchant.settings.hostedSession.functions.collectShippingAddress

object

Collect the customer's shipping address during checkout.

Hide child attributes

data.subMerchant.settings.hostedSession.functions.collectShippingAddress.enabled

boolean

Whether this setting is enabled.

data.subMerchant.settings.hostedSession.functions.collectEmail

object

Collect the customer's email address during checkout.

Hide child attributes

data.subMerchant.settings.hostedSession.functions.collectEmail.enabled

boolean

Whether this setting is enabled.

data.subMerchant.settings.hostedSession.functions.collectEmail.updateCustomer

boolean

When true, the collected value is saved to the customer record.

data.subMerchant.settings.hostedSession.functions.collectPhoneNumber

object

Collect the customer's phone number during checkout.

Hide child attributes

data.subMerchant.settings.hostedSession.functions.collectPhoneNumber.enabled

boolean

Whether this setting is enabled.

data.subMerchant.settings.hostedSession.functions.notes

object

Free-text notes displayed on the hosted page.

Hide child attributes

data.subMerchant.settings.hostedSession.functions.notes.enabled

boolean

Whether this setting is enabled.

data.subMerchant.settings.hostedSession.functions.callToAction

object

Customization of the pay button.

Hide child attributes

data.subMerchant.settings.hostedSession.functions.callToAction.enabled

boolean

Whether this setting is enabled.

data.subMerchant.settings.hostedSession.paymentMethods

object

Payment methods offered on the hosted page.

Hide child attributes

data.subMerchant.settings.hostedSession.paymentMethods.creditCard

object

Credit card acceptance settings for the hosted page.

Hide child attributes

data.subMerchant.settings.hostedSession.paymentMethods.creditCard.enabled

boolean

Whether this setting is enabled.

data.subMerchant.settings.hostedSession.paymentMethods.creditCard.cards

string[]

Card brands accepted.

data.subMerchant.settings.hostedSession.paymentMethods.eCheck

object

eCheck (ACH) acceptance settings for the hosted page.

Hide child attributes

data.subMerchant.settings.hostedSession.paymentMethods.eCheck.enabled

boolean

Whether this setting is enabled.

data.subMerchant.settings.hostedSession.paymentMethods.eCheck.accounts

string[]

Bank account types accepted.

data.subMerchant.settings.hostedSession.paymentMethods.applePay

object

Apple Pay acceptance settings for the hosted page.

Hide child attributes

data.subMerchant.settings.hostedSession.paymentMethods.applePay.enabled

boolean

Whether this setting is enabled.

data.subMerchant.settings.hostedSession.paymentMethods.googlePay

object

Google Pay acceptance settings for the hosted page.

Hide child attributes

data.subMerchant.settings.hostedSession.paymentMethods.googlePay.enabled

boolean

Whether this setting is enabled.

data.subMerchant.settings.invoice

object

Invoice settings.

Hide child attributes

data.subMerchant.settings.invoice.invoiceNumber

string

Invoice number displayed to the customer.

data.subMerchant.logs

string[]

Event log entries.

data.subMerchant.tags

string[]

Tags applied to the merchant.

data.subMerchant.acknowledgedAt

string

Timestamp when the merchant acknowledged (ISO 8601).

data.subMerchant.validations

object

Verification results returned by the issuer.

Hide child attributes

data.subMerchant.validations.enabled

boolean

Whether this setting is enabled.

data.subMerchant.validations.avs

object

Address Verification Service (AVS) results.

Hide child attributes

data.subMerchant.validations.avs.addressNumber

boolean

AVS result for the street number.

data.subMerchant.validations.avs.addressPostalCode

boolean

AVS result for the postal code.

data.subMerchant.validations.cvv

object

CVV check result.

Hide child attributes

data.subMerchant.validations.cvv.cvcCheck

boolean

Result of the card verification code check.

data.subMerchant.createdAt

string

Timestamp when the object was created (ISO 8601).

code

string

Machine-readable result code. See the Error Codes reference.

API Overview

API Reference

Resources

Get a plan

Authorizations

Path Parameters

Body

Response