Customer Integrations

Link customer integration

Links a customer to an external integration by specifying the vendor and external entity ID.

post/api/v1/customers/{id}/integrations

Path parameters

idstring required

The unique identifier of the entity

Headers

X-ACCOUNT-IDstring

Account ID — optional when authenticating with a user JWT (Bearer token); falls back to the user's first membership. Ignored for API-key auth.

X-ENVIRONMENT-IDstring

Environment ID — required when authenticating with a user JWT (Bearer token) on environment-scoped endpoints. Ignored for API-key auth (env is intrinsic to the key).

Request body

idstring required

Integration details

vendorIdentifier'AUTH0' | 'ZUORA' | 'STRIPE' | 'HUBSPOT' | 'AWS_MARKETPLACE' | 'SNOWFLAKE' | 'SALESFORCE' | 'BIG_QUERY' | 'OPEN_FGA' | 'APP_STORE' | 'RECEIVED' | 'PREQUEL' | 'AIRWALLEX' | 'STRIPE_INVOICING' required

The vendor identifier of integration

syncedEntityIdstring required

Synced entity id

Response

The created customer integration object.

Changes

Changed in 10 of the 115 revisions of this API.147

  • b876edd1a4fc51See the full diff
    • added the new CreditOveragePriceCurrencyNotFound enum value to the code response property for the response status 400

      response-property-enum-value-added

    • added the new InvalidCreditOverageBillingModel enum value to the code response property for the response status 400

      response-property-enum-value-added

    • added the new InvoicePreviewNotAvailableForDraftContract enum value to the code response property for the response status 400

      response-property-enum-value-added

    • added the new OveragePriceNotSupportedOnAddon enum value to the code response property for the response status 400

      response-property-enum-value-added

    • added the new OveragePriceRequiresUsageLimit enum value to the code response property for the response status 400

      response-property-enum-value-added

    • removed the InvoicePreviewNotAvailableForDraftContract enum value from the code response property for the response status 409

      response-property-enum-value-removed

  • 8d63db93d65611See the full diff
    • added the new STRIPE_INVOICING enum value to the data/vendorIdentifier response property for the response status 201

      response-property-enum-value-added

    • added the new STRIPE_INVOICING enum value to the request property vendorIdentifier

      request-property-enum-value-added

    • added the new GovernanceNotEnabled enum value to the code response property for the response status 403

      response-property-enum-value-added

  • 2fee3609afd211See the full diff
    • added the new AIRWALLEX enum value to the data/vendorIdentifier response property for the response status 201

      response-property-enum-value-added

    • added the new AIRWALLEX enum value to the request property vendorIdentifier

      request-property-enum-value-added

    • added the new InvoicePreviewNotAvailableForDraftContract enum value to the code response property for the response status 409

      response-property-enum-value-added

    • added the new optional header request parameter X-ACCOUNT-ID

      new-optional-request-parameter

    • added the new optional header request parameter X-ENVIRONMENT-ID

      new-optional-request-parameter

    • added the new PricingModelNotSupportedByBillingIntegration enum value to the code response property for the response status 400

      response-property-enum-value-added

    • added the new PREQUEL enum value to the data/vendorIdentifier response property for the response status 201

      response-property-enum-value-added

    • added the new PREQUEL enum value to the request property vendorIdentifier

      request-property-enum-value-added

    • added the new DataExportIntegrationError enum value to the code response property for the response status 400

      response-property-enum-value-added

  • b181b166a2a521See the full diff
    • added the new InvalidReceivedSignatureError enum value to the code response property for the response status 400

      response-property-enum-value-added

    • added the new RECEIVED enum value to the data/vendorIdentifier response property for the response status 201

      response-property-enum-value-added

    • added the new RECEIVED enum value to the request property vendorIdentifier

      request-property-enum-value-added