Create

API Reference

Customers

Create a customer

v1.customers.create(**kwargs) ->

post/v1/customers

Create a new customer

Parameters

nameString

This will be truncated to 160 characters if the provided name is longer.

billing_configobject

optional

{ billing_provider_customer_id, billing_provider_type, aws_is_subscription_product, 3 more}

Hide ParametersShow Parameters

billing_provider_customer_idString

billing_provider_typeunion

:aws_marketplace | :stripe | :netsuite | 5 more

Hide ParametersShow Parameters

:aws_marketplace

:stripe

:netsuite

:custom

:azure_marketplace

:quickbooks_online

:workday

:gcp_marketplace

aws_is_subscription_productbool

optional

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

aws_product_codeString

optional

aws_regionunion

optional

:"af-south-1" | :"ap-east-1" | :"ap-northeast-1" | 22 more

Hide ParametersShow Parameters

:"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"

stripe_collection_methodunion

optional

:charge_automatically | :send_invoice

Hide ParametersShow Parameters

:charge_automatically

:send_invoice

custom_fieldshash

optional

Hash[Symbol, String]

customer_billing_provider_configurationsarray

optional

Array[{ billing_provider, configuration, delivery_method, delivery_method_id}]

Hide ParametersShow Parameters

billing_providerunion

:aws_marketplace | :azure_marketplace | :gcp_marketplace | 2 more

The billing provider set for this configuration.

Hide ParametersShow Parameters

:aws_marketplace

:azure_marketplace

:gcp_marketplace

:stripe

:netsuite

configurationhash

optional

Hash[Symbol, untyped]

Configuration for the billing provider. The structure of this object is specific to the billing provider and delivery provider combination. Defaults to an empty object, however, for most billing provider + delivery method combinations, it will not be a valid configuration.

delivery_methodunion

optional

:direct_to_billing_provider | :aws_sqs | :tackle | :aws_sns

The method to use for delivering invoices to this customer. If not provided, the delivery_method_id must be provided.

Hide ParametersShow Parameters

:direct_to_billing_provider

:aws_sqs

:tackle

:aws_sns

delivery_method_idString

optional

ID of the delivery method to use for this customer. If not provided, the delivery_method must be provided.

formatuuid

external_idString

optional

(deprecated, use ingest_aliases instead) an alias that can be used to refer to this customer in usage events

minLength1

maxLength128

ingest_aliasesarray

optional

Array[String]

Aliases that can be used to refer to this customer in usage events

Returns

CustomerCreateResponseclass

Hide ParametersShow Parameters

data

require "metronome_sdk"

metronome = MetronomeSDK::Client.new(bearer_token: "My Bearer Token")

customer = metronome.v1.customers.create(name: "Example, Inc.")

puts(customer)

200 Example

{
  "data": {
    "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
    "external_id": "external_id",
    "ingest_aliases": [
      "string"
    ],
    "name": "name",
    "custom_fields": {
      "foo": "string"
    }
  }
}