Update Payment Settings
PUT /v1/payment
Updates the payment configuration settings for the tenant including payment methods, subscription options, upfront payment choices, and billing intervals. The endpoint validates all payment settings against business rules and updates the configuration accordingly. Returns the complete updated payment settings object with all current values including methods, subscriptions, upfronts, and default preferences.
Request Body
{
"interval": {
"type": "arrears",
"value": 3
},
"default": {
"method": "card",
"upfront": "1_year_upfront",
"subscription": "1_year"
},
"_id": "6458d04de34d15c1f7baa0d1",
"tenant": "6065a9eb6783e09eb34bb844",
"methods": [
{
"title": "Invoice",
"description": "The user receives an invoice and pays by making a wire transfer.",
"type": "invoice",
"_id": "6062fa6dc44fd51c34b1a111"
}
],
"upfronts": [
{
"name": "1 year upfront",
"machine_name": "1_year_upfront",
"description": "Longer description for holdover...",
"upfront": 12,
"discount": 10,
"_id": "6062fa6dc44fd51c34b1a121"
}
],
"subscriptions": [
{
"name": "1 year",
"machine_name": "1_year",
"description": "Longer description for holdover...",
"length": 12,
"discount": 0,
"_id": "6062fa6dc44fd51c34b1a211",
"created": "2023-03-28T16:10:31.836Z",
"updated": "2023-03-28T16:10:31.836Z"
},
{
"name": "2 year",
"machine_name": "2_year",
"description": "Longer description for holdover...",
"length": 22,
"discount": 2,
"_id": "6458d086e34d15c1f7baa188",
"created": "2023-05-08T10:35:50.767Z",
"updated": "2023-05-08T10:35:50.767Z",
"default": false
},
{
"name": "3 year",
"machine_name": "3_year",
"description": "Longer description for holdover...",
"length": 36,
"discount": 6,
"default": true
}
],
"duedays": 9
}