Create

API Reference

Customers

Create a customer

client.V1.Customers.New(ctx, body) (*, error)

post/v1/customers

Create a new customer

Parameters

body

Hide ParametersShow Parameters

Namefield

param.Field[string]

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

BillingConfigfield

optional

param.Field[V1CustomerNewParamsBillingConfig]

Hide ParametersShow Parameters

BillingProviderCustomerIDstring

BillingProviderType

Hide ParametersShow Parameters

V1CustomerNewParamsBillingConfigBillingProviderTypeAwsMarketplaceconst

"aws_marketplace"

V1CustomerNewParamsBillingConfigBillingProviderTypeStripeconst

"stripe"

V1CustomerNewParamsBillingConfigBillingProviderTypeNetsuiteconst

"netsuite"

V1CustomerNewParamsBillingConfigBillingProviderTypeCustomconst

"custom"

V1CustomerNewParamsBillingConfigBillingProviderTypeAzureMarketplaceconst

"azure_marketplace"

V1CustomerNewParamsBillingConfigBillingProviderTypeQuickbooksOnlineconst

"quickbooks_online"

V1CustomerNewParamsBillingConfigBillingProviderTypeWorkdayconst

"workday"

V1CustomerNewParamsBillingConfigBillingProviderTypeGcpMarketplaceconst

"gcp_marketplace"

AwsIsSubscriptionProductbool

optional

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

AwsProductCodestring

optional

AwsRegion

optional

Hide ParametersShow Parameters

V1CustomerNewParamsBillingConfigAwsRegionAfSouth1const

"af-south-1"

V1CustomerNewParamsBillingConfigAwsRegionApEast1const

"ap-east-1"

V1CustomerNewParamsBillingConfigAwsRegionApNortheast1const

"ap-northeast-1"

V1CustomerNewParamsBillingConfigAwsRegionApNortheast2const

"ap-northeast-2"

V1CustomerNewParamsBillingConfigAwsRegionApNortheast3const

"ap-northeast-3"

V1CustomerNewParamsBillingConfigAwsRegionApSouth1const

"ap-south-1"

V1CustomerNewParamsBillingConfigAwsRegionApSoutheast1const

"ap-southeast-1"

V1CustomerNewParamsBillingConfigAwsRegionApSoutheast2const

"ap-southeast-2"

V1CustomerNewParamsBillingConfigAwsRegionCaCentral1const

"ca-central-1"

V1CustomerNewParamsBillingConfigAwsRegionCnNorth1const

"cn-north-1"

V1CustomerNewParamsBillingConfigAwsRegionCnNorthwest1const

"cn-northwest-1"

V1CustomerNewParamsBillingConfigAwsRegionEuCentral1const

"eu-central-1"

V1CustomerNewParamsBillingConfigAwsRegionEuNorth1const

"eu-north-1"

V1CustomerNewParamsBillingConfigAwsRegionEuSouth1const

"eu-south-1"

V1CustomerNewParamsBillingConfigAwsRegionEuWest1const

"eu-west-1"

V1CustomerNewParamsBillingConfigAwsRegionEuWest2const

"eu-west-2"

V1CustomerNewParamsBillingConfigAwsRegionEuWest3const

"eu-west-3"

V1CustomerNewParamsBillingConfigAwsRegionMeSouth1const

"me-south-1"

V1CustomerNewParamsBillingConfigAwsRegionSaEast1const

"sa-east-1"

V1CustomerNewParamsBillingConfigAwsRegionUsEast1const

"us-east-1"

V1CustomerNewParamsBillingConfigAwsRegionUsEast2const

"us-east-2"

V1CustomerNewParamsBillingConfigAwsRegionUsGovEast1const

"us-gov-east-1"

V1CustomerNewParamsBillingConfigAwsRegionUsGovWest1const

"us-gov-west-1"

V1CustomerNewParamsBillingConfigAwsRegionUsWest1const

"us-west-1"

V1CustomerNewParamsBillingConfigAwsRegionUsWest2const

"us-west-2"

StripeCollectionMethod

optional

Hide ParametersShow Parameters

V1CustomerNewParamsBillingConfigStripeCollectionMethodChargeAutomaticallyconst

"charge_automatically"

V1CustomerNewParamsBillingConfigStripeCollectionMethodSendInvoiceconst

"send_invoice"

CustomFieldsfield

optional

param.Field[map[string, string]]

CustomerBillingProviderConfigurationsfield

optional

param.Field[[]V1CustomerNewParamsCustomerBillingProviderConfiguration]

Hide ParametersShow Parameters

BillingProvider

The billing provider set for this configuration.

Hide ParametersShow Parameters

V1CustomerNewParamsCustomerBillingProviderConfigurationsBillingProviderAwsMarketplaceconst

"aws_marketplace"

V1CustomerNewParamsCustomerBillingProviderConfigurationsBillingProviderAzureMarketplaceconst

"azure_marketplace"

V1CustomerNewParamsCustomerBillingProviderConfigurationsBillingProviderGcpMarketplaceconst

"gcp_marketplace"

V1CustomerNewParamsCustomerBillingProviderConfigurationsBillingProviderStripeconst

"stripe"

V1CustomerNewParamsCustomerBillingProviderConfigurationsBillingProviderNetsuiteconst

"netsuite"

Configurationmap

optional

map[string, unknown]

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.

DeliveryMethod

optional

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

Hide ParametersShow Parameters

V1CustomerNewParamsCustomerBillingProviderConfigurationsDeliveryMethodDirectToBillingProviderconst

"direct_to_billing_provider"

V1CustomerNewParamsCustomerBillingProviderConfigurationsDeliveryMethodAwsSqsconst

"aws_sqs"

V1CustomerNewParamsCustomerBillingProviderConfigurationsDeliveryMethodTackleconst

"tackle"

V1CustomerNewParamsCustomerBillingProviderConfigurationsDeliveryMethodAwsSnsconst

"aws_sns"

DeliveryMethodIDstring

optional

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

formatuuid

ExternalIDfield

optional

param.Field[string]

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

minLength1

maxLength128

IngestAliasesfield

optional

param.Field[[]string]

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

Returns

V1CustomerNewResponsestruct

Hide ParametersShow Parameters

Data

package main

import (
  "context"
  "fmt"

  "github.com/Metronome-Industries/metronome-go"
  "github.com/Metronome-Industries/metronome-go/option"
)

func main() {
  client := metronome.NewClient(
    option.WithBearerToken("My Bearer Token"),
  )
  customer, err := client.V1.Customers.New(context.TODO(), metronome.V1CustomerNewParams{
    Name: metronome.F("Example, Inc."),
    CustomerBillingProviderConfigurations: metronome.F([]metronome.V1CustomerNewParamsCustomerBillingProviderConfiguration{metronome.V1CustomerNewParamsCustomerBillingProviderConfiguration{
      BillingProvider: metronome.F(metronome.V1CustomerNewParamsCustomerBillingProviderConfigurationsBillingProviderStripe),
      DeliveryMethod: metronome.F(metronome.V1CustomerNewParamsCustomerBillingProviderConfigurationsDeliveryMethodDirectToBillingProvider),
      Configuration: metronome.F(map[string]interface{}{
      "stripe_customer_id": "cus_123",
      "stripe_collection_method": "charge_automatically",
      }),
    }}),
    IngestAliases: metronome.F([]string{"[email protected]"}),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", customer.Data)
}

200 Example

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