Archive billing provider configurations for a customer

curl --request POST \
  --url https://api.metronome.com/v1/archiveCustomerBillingProviderConfigurations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customer_billing_provider_configuration_ids": [
    "4db51251-61de-4bfe-b9ce-495e244f3491",
    "4db51251-61de-4bfe-b9ce-495e244f3491"
  ],
  "customer_id": "20a060d1-aa80-41d4-8bb2-4f3091b93903"
}
'

import requests

url = "https://api.metronome.com/v1/archiveCustomerBillingProviderConfigurations"

payload = {
    "customer_billing_provider_configuration_ids": ["4db51251-61de-4bfe-b9ce-495e244f3491", "4db51251-61de-4bfe-b9ce-495e244f3491"],
    "customer_id": "20a060d1-aa80-41d4-8bb2-4f3091b93903"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    customer_billing_provider_configuration_ids: ['4db51251-61de-4bfe-b9ce-495e244f3491', '4db51251-61de-4bfe-b9ce-495e244f3491'],
    customer_id: '20a060d1-aa80-41d4-8bb2-4f3091b93903'
  })
};

fetch('https://api.metronome.com/v1/archiveCustomerBillingProviderConfigurations', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.metronome.com/v1/archiveCustomerBillingProviderConfigurations",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'customer_billing_provider_configuration_ids' => [
        '4db51251-61de-4bfe-b9ce-495e244f3491',
        '4db51251-61de-4bfe-b9ce-495e244f3491'
    ],
    'customer_id' => '20a060d1-aa80-41d4-8bb2-4f3091b93903'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.metronome.com/v1/archiveCustomerBillingProviderConfigurations"

	payload := strings.NewReader("{\n  \"customer_billing_provider_configuration_ids\": [\n    \"4db51251-61de-4bfe-b9ce-495e244f3491\",\n    \"4db51251-61de-4bfe-b9ce-495e244f3491\"\n  ],\n  \"customer_id\": \"20a060d1-aa80-41d4-8bb2-4f3091b93903\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.metronome.com/v1/archiveCustomerBillingProviderConfigurations")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"customer_billing_provider_configuration_ids\": [\n    \"4db51251-61de-4bfe-b9ce-495e244f3491\",\n    \"4db51251-61de-4bfe-b9ce-495e244f3491\"\n  ],\n  \"customer_id\": \"20a060d1-aa80-41d4-8bb2-4f3091b93903\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.metronome.com/v1/archiveCustomerBillingProviderConfigurations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"customer_billing_provider_configuration_ids\": [\n    \"4db51251-61de-4bfe-b9ce-495e244f3491\",\n    \"4db51251-61de-4bfe-b9ce-495e244f3491\"\n  ],\n  \"customer_id\": \"20a060d1-aa80-41d4-8bb2-4f3091b93903\"\n}"

response = http.request(request)
puts response.read_body

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

{
  "message": "<string>"
}

{
  "message": "<string>"
}

Customers

Archive billing provider configurations for a customer

Deprecate an existing billing configuration for a customer to handle churn or billing and collection preference changes. Archiving a billing configuration takes effect immediately. If there are active contracts using the configuration, Metronome will archive the configuration on the contract and immediately stop metering to downstream systems.

Use this endpoint to:

Remove billing provider customer data and configurations when no longer needed
Clean up test or deprecated billing provider configurations
Free up uniqueness keys for reuse with new billing provider configurations
Disable threshold recharge configurations associated with archived billing providers

Key response fields:

A successful response returns:

success: Boolean indicating the operation completed successfully
error: Null on success, error message on failure

Usage guidelines:

Archiving a contract configuration during a grace period will result in the invoice not being sent to the customer
Automatically disables both spend-based and credit-based threshold recharge configurations for contracts using the archived billing provider
You can archive multiple configurations for a single customer in a single request, but any validation failures for an individual configuration will prevent the entire operation from succeeding

POST

archiveCustomerBillingProviderConfigurations

Archive billing provider configurations for a customer

curl --request POST \
  --url https://api.metronome.com/v1/archiveCustomerBillingProviderConfigurations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customer_billing_provider_configuration_ids": [
    "4db51251-61de-4bfe-b9ce-495e244f3491",
    "4db51251-61de-4bfe-b9ce-495e244f3491"
  ],
  "customer_id": "20a060d1-aa80-41d4-8bb2-4f3091b93903"
}
'

import requests

url = "https://api.metronome.com/v1/archiveCustomerBillingProviderConfigurations"

payload = {
    "customer_billing_provider_configuration_ids": ["4db51251-61de-4bfe-b9ce-495e244f3491", "4db51251-61de-4bfe-b9ce-495e244f3491"],
    "customer_id": "20a060d1-aa80-41d4-8bb2-4f3091b93903"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    customer_billing_provider_configuration_ids: ['4db51251-61de-4bfe-b9ce-495e244f3491', '4db51251-61de-4bfe-b9ce-495e244f3491'],
    customer_id: '20a060d1-aa80-41d4-8bb2-4f3091b93903'
  })
};

fetch('https://api.metronome.com/v1/archiveCustomerBillingProviderConfigurations', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.metronome.com/v1/archiveCustomerBillingProviderConfigurations",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'customer_billing_provider_configuration_ids' => [
        '4db51251-61de-4bfe-b9ce-495e244f3491',
        '4db51251-61de-4bfe-b9ce-495e244f3491'
    ],
    'customer_id' => '20a060d1-aa80-41d4-8bb2-4f3091b93903'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.metronome.com/v1/archiveCustomerBillingProviderConfigurations"

	payload := strings.NewReader("{\n  \"customer_billing_provider_configuration_ids\": [\n    \"4db51251-61de-4bfe-b9ce-495e244f3491\",\n    \"4db51251-61de-4bfe-b9ce-495e244f3491\"\n  ],\n  \"customer_id\": \"20a060d1-aa80-41d4-8bb2-4f3091b93903\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.metronome.com/v1/archiveCustomerBillingProviderConfigurations")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"customer_billing_provider_configuration_ids\": [\n    \"4db51251-61de-4bfe-b9ce-495e244f3491\",\n    \"4db51251-61de-4bfe-b9ce-495e244f3491\"\n  ],\n  \"customer_id\": \"20a060d1-aa80-41d4-8bb2-4f3091b93903\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.metronome.com/v1/archiveCustomerBillingProviderConfigurations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"customer_billing_provider_configuration_ids\": [\n    \"4db51251-61de-4bfe-b9ce-495e244f3491\",\n    \"4db51251-61de-4bfe-b9ce-495e244f3491\"\n  ],\n  \"customer_id\": \"20a060d1-aa80-41d4-8bb2-4f3091b93903\"\n}"

response = http.request(request)
puts response.read_body

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

{
  "message": "<string>"
}

{
  "message": "<string>"
}

Authorizations

Authorization

string

header

required

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

Body

application/json

The ids of the billing provider configurations to archive

customer_billing_provider_configuration_ids

string<uuid>[]

required

Array of billing provider configuration IDs to archive

customer_id

string<uuid>

required

The customer ID the billing provider configurations belong to

Response

Success

data

object

required

Show child attributes

Archive a customer

Create a custom field key

⌘I

GET STARTED

ESSENTIALS

ENDPOINTS

Archive billing provider configurations for a customer

Use this endpoint to:

Key response fields:

Usage guidelines:

Authorizations

Body

Response