Migrate plans credit grants to contracts credits and commits.

curl --request POST \
  --url https://api.metronome.com/v1/credits/migrateToContracts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customer_id": "9b85c1c1-5238-4f2a-a409-61412905e1e1",
  "cutover_date": "2024-02-01T00:00:00Z",
  "contract_credits_product_id": "7d21bedf-0f29-4dfe-b5a9-e90888ca46cf",
  "contract_prepaid_commits_product_id": "098bf77f-d6bf-4d08-816f-c9434fdc90fa",
  "contract_credits_priority_override": 0.5,
  "contract_prepaid_commits_priority_override": 0.5,
  "grant_to_contract_commit_mapping": [
    {
      "credit_grant_id": "123e4567-e89b-12d3-a456-426614174000",
      "contract_id": "987fcdeb-51a2-43d1-9b8c-765432109876",
      "product_id": "abc12345-6789-0123-4567-890123456789"
    },
    {
      "credit_grant_id": "456e7890-e89b-12d3-a456-426614174001",
      "contract_id": "654fcdeb-51a2-43d1-9b8c-765432109875",
      "product_id": "def67890-1234-5678-9012-345678901234"
    }
  ],
  "dry_run": false,
  "batch_size": 300
}
'

{
  "credit_grants_migrated": 123,
  "has_more": true
}

Credits

Migrate plans credit grants to contracts credits and commits.

Migrates a given customer’s plan credit grants to contract credits and commits in batches. Callers should check the has_more field of the response to determine if there are more credit grants to migrate.

Plan credit grants with no cost basis get migrated to contract credits.
Plan credit grants with positive cost basis get migrated to contract Commits with an empty invoice schedule so they don’t get re-invoiced.
Deductions from existing grants are migrated to one-off contract deductions.
If not hour-aligned, the effective_at date of the migrated plan credit grant is rounded down to the nearest hour. e.g. 2024-01-01T12:34:56Z becomes 2024-01-01T12:00:00Z
If not hour-aligned, the expires_at date of the migrated plan credit grant is rounded up to the nearest hour. e.g. 2024-01-01T12:34:56Z becomes 2024-01-01T13:00:00Z

This is a Plans (deprecated) endpoint. New clients should implement using Contracts.

The migrated plan credit grants are truncated to the cutover date, or voided if they fall completely after the cutover date.

POST

credits

migrateToContracts

Migrate plans credit grants to contracts credits and commits.

curl --request POST \
  --url https://api.metronome.com/v1/credits/migrateToContracts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customer_id": "9b85c1c1-5238-4f2a-a409-61412905e1e1",
  "cutover_date": "2024-02-01T00:00:00Z",
  "contract_credits_product_id": "7d21bedf-0f29-4dfe-b5a9-e90888ca46cf",
  "contract_prepaid_commits_product_id": "098bf77f-d6bf-4d08-816f-c9434fdc90fa",
  "contract_credits_priority_override": 0.5,
  "contract_prepaid_commits_priority_override": 0.5,
  "grant_to_contract_commit_mapping": [
    {
      "credit_grant_id": "123e4567-e89b-12d3-a456-426614174000",
      "contract_id": "987fcdeb-51a2-43d1-9b8c-765432109876",
      "product_id": "abc12345-6789-0123-4567-890123456789"
    },
    {
      "credit_grant_id": "456e7890-e89b-12d3-a456-426614174001",
      "contract_id": "654fcdeb-51a2-43d1-9b8c-765432109875",
      "product_id": "def67890-1234-5678-9012-345678901234"
    }
  ],
  "dry_run": false,
  "batch_size": 300
}
'

{
  "credit_grants_migrated": 123,
  "has_more": true
}

Authorizations

Authorization

string

header

required

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

Body

application/json

Parameters for migrating credit grants to contracts.

customer_id

string<uuid>

required

The customer ID to migrate credit grants for.

cutover_date

string<date-time>

required

The date to truncate existing plan credit grants to. This should likely be the end date of the customer's most recently finalized invoice.

contract_credits_product_id

string<uuid>

required

The product ID to use for contract credits.

contract_prepaid_commits_product_id

string<uuid>

required

The product ID to use for contract prepaid commits.

contract_credits_priority_override

number

The priority to use for contract credits.

contract_prepaid_commits_priority_override

number

The priority to use for contract prepaid commits.

grant_to_contract_commit_mapping

object[]

Optional mapping configuration for migrating specific credit grants to contract commits. If not provided, defaults to empty array.

Show child attributes

grant_to_contract_commit_mapping.credit_grant_id

string<uuid>

The ID of the credit grant to migrate

grant_to_contract_commit_mapping.contract_id

string<uuid>

The ID of the contract to migrate to

grant_to_contract_commit_mapping.product_id

string<uuid>

The ID of the product to use for the contract commit

dry_run

boolean

If true, perform a dry run without actually executing the migration. If not provided, defaults to false.

batch_size

number

The number of credit grants to migrate in this batch.

Response

200 - application/json

Success

credit_grants_migrated

number

required

The number of credit grants migrated.

has_more

boolean

required

Whether the customer has more credit grants to migrate.

⌘I