Set billing provider configurations for a customer

curl --request POST \
  --url https://api.metronome.com/v1/setCustomerBillingProviderConfigurations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "data": [
    {
      "customer_id": "4db51251-61de-4bfe-b9ce-495e244f3491",
      "billing_provider": "stripe",
      "configuration": {
        "stripe_customer_id": "cus_1234",
        "stripe_collection_method": "charge_automatically",
        "leave_stripe_invoices_in_draft": true
      },
      "delivery_method": "direct_to_billing_provider"
    },
    {
      "customer_id": "4db51251-61de-4bfe-b9ce-495e244f3491",
      "billing_provider": "aws_marketplace",
      "configuration": {
        "aws_customer_id": "ABC123ABC12",
        "aws_product_code": "my_product",
        "aws_region": "us-west-1"
      },
      "delivery_method": "direct_to_billing_provider"
    },
    {
      "customer_id": "4db51251-61de-4bfe-b9ce-495e244f3491",
      "billing_provider": "azure_marketplace",
      "configuration": {
        "azure_subscription_id": "my_subscription"
      },
      "delivery_method_id": "5b9e3072-415b-4842-94f0-0b6700c8b6be"
    },
    {
      "customer_id": "4db51251-61de-4bfe-b9ce-495e244f3491",
      "billing_provider": "aws_marketplace",
      "configuration": {
        "aws_customer_id": "ABC123ABC12",
        "aws_product_code": "my_product",
        "aws_region": "us-west-1",
        "aws_is_subscription_product": true
      },
      "delivery_method": "direct_to_billing_provider"
    },
    {
      "customer_id": "4db51251-61de-4bfe-b9ce-495e244f3491",
      "billing_provider": "gcp_marketplace",
      "configuration": {
        "gcp_entitlement_id": "my_entitlement",
        "gcp_service_name": "my.service.endpoint.goog"
      },
      "delivery_method": "direct_to_billing_provider"
    },
    {
      "customer_id": "4db51251-61de-4bfe-b9ce-495e244f3491",
      "billing_provider": "netsuite",
      "configuration": {
        "netsuite_customer_id": "12345"
      },
      "delivery_method": "direct_to_billing_provider"
    }
  ]
}
'

{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "configuration": {},
      "delivery_method_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ]
}

Customers

Set billing provider configurations for a customer

Create a billing configuration for a customer. Once created, these configurations are available to associate to a contract and dictates which downstream system to collect payment in or send the invoice to. You can create multiple configurations per customer. The configuration formats are distinct for each downstream provider.

Use this endpoint to:

Add the initial configuration to an existing customer. Once created, the billing configuration can then be associated to the customer’s contract.
Add a new configuration to an existing customer. This might be used as part of an upgrade or downgrade workflow where the customer was previously billed through system A (e.g. Stripe) but will now be billed through system B (e.g. AWS). Once created, the new configuration can then be associated to the customer’s contract.
Multiple configurations can be added per destination. For example, you can create two Stripe billing configurations for a Metronome customer that each have a distinct collection_method.

Delivery method options:

direct_to_billing_provider: Use when Metronome should send invoices directly to the billing provider’s API (e.g., Stripe, NetSuite). This is the most common method for automated billing workflows.
tackle: Use specifically for AWS Marketplace transactions that require Tackle’s co-selling platform for partner attribution and commission tracking.
aws_sqs: Use when you want invoice data delivered to an AWS SQS queue for custom processing before sending to your billing system.
aws_sns: Use when you want invoice notifications published to an AWS SNS topic for event-driven billing workflows.

Key response fields:

The id for the customer billing configuration. This id can be used to associate the billing configuration to a contract.

Usage guidelines:

Must use the delivery_method_id if you have multiple Stripe accounts connected to Metronome.

POST

setCustomerBillingProviderConfigurations

Set billing provider configurations for a customer

curl --request POST \
  --url https://api.metronome.com/v1/setCustomerBillingProviderConfigurations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "data": [
    {
      "customer_id": "4db51251-61de-4bfe-b9ce-495e244f3491",
      "billing_provider": "stripe",
      "configuration": {
        "stripe_customer_id": "cus_1234",
        "stripe_collection_method": "charge_automatically",
        "leave_stripe_invoices_in_draft": true
      },
      "delivery_method": "direct_to_billing_provider"
    },
    {
      "customer_id": "4db51251-61de-4bfe-b9ce-495e244f3491",
      "billing_provider": "aws_marketplace",
      "configuration": {
        "aws_customer_id": "ABC123ABC12",
        "aws_product_code": "my_product",
        "aws_region": "us-west-1"
      },
      "delivery_method": "direct_to_billing_provider"
    },
    {
      "customer_id": "4db51251-61de-4bfe-b9ce-495e244f3491",
      "billing_provider": "azure_marketplace",
      "configuration": {
        "azure_subscription_id": "my_subscription"
      },
      "delivery_method_id": "5b9e3072-415b-4842-94f0-0b6700c8b6be"
    },
    {
      "customer_id": "4db51251-61de-4bfe-b9ce-495e244f3491",
      "billing_provider": "aws_marketplace",
      "configuration": {
        "aws_customer_id": "ABC123ABC12",
        "aws_product_code": "my_product",
        "aws_region": "us-west-1",
        "aws_is_subscription_product": true
      },
      "delivery_method": "direct_to_billing_provider"
    },
    {
      "customer_id": "4db51251-61de-4bfe-b9ce-495e244f3491",
      "billing_provider": "gcp_marketplace",
      "configuration": {
        "gcp_entitlement_id": "my_entitlement",
        "gcp_service_name": "my.service.endpoint.goog"
      },
      "delivery_method": "direct_to_billing_provider"
    },
    {
      "customer_id": "4db51251-61de-4bfe-b9ce-495e244f3491",
      "billing_provider": "netsuite",
      "configuration": {
        "netsuite_customer_id": "12345"
      },
      "delivery_method": "direct_to_billing_provider"
    }
  ]
}
'

{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "customer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "configuration": {},
      "delivery_method_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

The details of the billing provider configurations to insert

data

object[]

required

Show child attributes

Response

Success

data

object[]

required

Show child attributes

Update a customer configuration

Fetch billing provider configurations for a customer

⌘I