Get a customer billing configuration

curl --request GET \
  --url https://api.metronome.com/v1/customers/{customer_id}/billing-config/{billing_provider_type} \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "billing_provider_customer_id": "<string>",
    "stripe_collection_method": "charge_automatically",
    "aws_product_code": "<string>",
    "aws_region": "af-south-1",
    "aws_expiration_date": "2023-11-07T05:31:56Z",
    "aws_is_subscription_product": true,
    "azure_subscription_status": "Subscribed",
    "azure_plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "azure_start_date": "2023-11-07T05:31:56Z",
    "azure_expiration_date": "2023-11-07T05:31:56Z"
  }
}

GET

customers

{customer_id}

billing-config

{billing_provider_type}

Get a customer billing configuration

curl --request GET \
  --url https://api.metronome.com/v1/customers/{customer_id}/billing-config/{billing_provider_type} \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "billing_provider_customer_id": "<string>",
    "stripe_collection_method": "charge_automatically",
    "aws_product_code": "<string>",
    "aws_region": "af-south-1",
    "aws_expiration_date": "2023-11-07T05:31:56Z",
    "aws_is_subscription_product": true,
    "azure_subscription_status": "Subscribed",
    "azure_plan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "azure_start_date": "2023-11-07T05:31:56Z",
    "azure_expiration_date": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization

string

header

required

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

Path Parameters

customer_id

string<uuid>

required

billing_provider_type

enum<string>

required

The billing provider (e.g. stripe)

Available options:

aws_marketplace,

stripe,

azure_marketplace,

quickbooks_online,

metronome

Response

Success

data

object

required

Show child attributes

data.billing_provider_customer_id

string

data.stripe_collection_method

enum<string>

The collection method for the customer's invoices. NOTE: auto_charge_payment_intent and manually_charge_payment_intent are in beta.

Available options:

charge_automatically,

send_invoice,

auto_charge_payment_intent,

manually_charge_payment_intent

data.aws_product_code

string

data.aws_region

enum<string>

Available options:

af-south-1,

ap-east-1,

ap-northeast-1,

ap-northeast-2,

ap-northeast-3,

ap-south-1,

ap-southeast-1,

ap-southeast-2,

ca-central-1,

cn-north-1,

cn-northwest-1,

eu-central-1,

eu-north-1,

eu-south-1,

eu-west-1,

eu-west-2,

eu-west-3,

me-south-1,

sa-east-1,

us-east-1,

us-east-2,

us-gov-east-1,

us-gov-west-1,

us-west-1,

us-west-2

data.aws_expiration_date

string<date-time>

Contract expiration date for the customer. The expected format is RFC 3339 and can be retrieved from AWS's GetEntitlements API.

data.aws_is_subscription_product

boolean

True if the aws_product_code is a SAAS subscription product, false otherwise.

data.azure_subscription_status

enum<string>

Available options:

Subscribed,

Unsubscribed,

Suspended,

PendingFulfillmentStart

data.azure_plan_id

string<uuid>

data.azure_start_date

string<date-time>

Subscription term start/end date for the customer. The expected format is RFC 3339 and can be retrieved from Azure's Get Subscription API.

data.azure_expiration_date

string<date-time>

Subscription term start/end date for the customer. The expected format is RFC 3339 and can be retrieved from Azure's Get Subscription API.

Add a one time charge

Set a customer billing configuration

⌘I

Plans-Specific Endpoints

Plans-Contracts Shared Endpoints

Get a customer billing configuration

Authorizations

Path Parameters

Response