v51

latestOpenAPI 3.0.0Apache 2.0raw.githubusercontent.com2026-08-011534301009.2 KB

Apps

Install app via API key

Install an marketplace app via API Key.

post/api/v1/marketplace/listings/{type}/install/apikey

Path parameters

type'stripe' | 'sandbox' | 'custom_invoicing' required

Type of the app.

The type of the app to install.

Request body

namestring

Name of the application to install.

If name is not provided defaults to the marketplace listing's name.

createBillingProfileboolean

If true, a billing profile will be created for the app. The Stripe app will be also set as the default billing profile if the current default is a Sandbox app.

apiKeystring required

The API key for the provider. For example, the Stripe API key.

Response

The request has succeeded.

defaultForCapabilityTypesAppCapabilityType[] required

Default for capabilities

Example response

{
  "app": {
    "id": "01G65Z755AFWAKHE12NY0CQ9FH",
    "type": "stripe",
    "name": "Stripe",
    "status": "ready",
    "listing": {
      "type": "stripe",
      "name": "Stripe",
      "description": "Stripe integration allows you to collect payments with Stripe.",
      "capabilities": [
        {
          "type": "calculateTax",
          "key": "stripe_calculate_tax",
          "name": "Calculate Tax",
          "description": "Stripe Tax calculates tax portion of the invoices."
        },
        {
          "type": "invoiceCustomers",
          "key": "stripe_invoice_customers",
          "name": "Invoice Customers",
          "description": "Stripe invoices customers with due amount."
        },
        {
          "type": "collectPayments",
          "key": "stripe_collect_payments",
          "name": "Collect Payments",
          "description": "Stripe payments collects outstanding revenue with Stripe customer's default payment method."
        }
      ],
      "installMethods": [
        "with_oauth2",
        "with_api_key"
      ]
    },
    "createdAt": "2024-01-01T01:01:01.001Z",
    "updatedAt": "2024-01-01T01:01:01.001Z",
    "stripeAccountId": "acct_123456789",
    "livemode": true,
    "maskedAPIKey": "sk_live_************abc"
  }
}