Skip to main content

Assign plans to customers

To invoice a customer, they must be on a plan. Once you've set up at least one product and plan, you can add that to an existing customer. Plans can be added using the Metronome app or the API, using the /customers/{customer_id}/plans/add endpoint.

The plan ID and starting datetime are required. You can optionally provide: an ending date, payment terms (for the invoice), and price adjustments.

To assign a plan in the Metronome app:

  1. On the Customers page, click on the customer record.
  2. On the customer's detail page, click Plans to start the configuration wizard.
  3. On the resulting page, click Add a plan.
  4. On the resulting page, click on the correct plan to select it, then click Continue.
  5. If everything looks correct on the preview page, click Continue.
  6. On the Plan terms page, configure the plan, then click Continue:
    • Start and (optional) end date
    • Any price adjustments
    • Optional trial period
    • Optional trial price cap
  7. On the Configure billing page, set the net payment terms, then click Continue.
  8. Preview your plan and click Done to activate the customer's plan.

To assign a plan through the API, make a POST request to /customers/{customer_id}/plans/add.

curl \
-H "Authorization: Bearer TOKEN" \
-H "Content-Type: application/json" \
-d '{
"plan_id": "d2c06dae-9549-4d7d-bc04-b78dd3d241b8",
"starting_on": "2024-02-01T00:00:00:00Z",
Metronome logoMetronome logo