Update your platform

PATCH

/v:version/platforms/:resourceId

PATCH

/v:version/platforms/:resourceId

curl -X PATCH https://test.api.solvimon.com/v1/platforms/ \
     -H "X-API-KEY: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "reference": "lumen_ai",
  "status": "ACTIVE",
  "timezone": "Europe/Amsterdam",
  "description": "Lumen AI production billing",
  "default_product_tax_category": "STANDARD",
  "default_pricing_plan_subscription_settings": {
    "billing_entity_id": "bile_iwDeeN0vxxHxNDCUNS1G",
    "due_date_configuration": {
      "type": "PERIOD_AFTER_INVOICE_DATE",
      "period": {
        "type": "DAY",
        "value": 14
      }
    },
    "billing_period": {
      "type": "MONTH",
      "value": 1
    },
    "billing_currency": "EUR",
    "billing_time": "CALENDAR",
    "combine": true,
    "init_invoice_on_hold": false,
    "payment_acceptor_ids": [
      "paya_TwDeeN0vxxHyl9COvu1H",
      "paya_twDeeN0vxxHyldCKvk1w"
    ]
  },
  "branding": {
    "colors": {
      "primary": "#1F2A44",
      "secondary": "#F5A524"
    },
    "logo": {
      "file_name": "lumen-ai-logo.png",
      "content_type": "image/png",
      "content": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNkYPhfDwAChwGA60e6kgAAAABJRU5ErkJggg=="
    },
    "emblem": {
      "file_name": "lumen-ai-emblem.png",
      "content_type": "image/png",
      "content": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNkYPhfDwAChwGA60e6kgAAAABJRU5ErkJggg=="
    },
    "name": "Lumen AI",
    "domain": "billing.lumen-ai.example.com"
  },
  "invoice_settings": {
    "invoice_date_determination_type": "AFTER_END_OF_BILLING_PERIOD"
  },
  "reporting_currency": "EUR",
  "default_pricing_currency": "EUR"
}'

{
  "object_type": "string",
  "created_at": "string",
  "id": "string",
  "reference": "string",
  "status": "string",
  "timezone": "string",
  "description": "string",
  "entity_id": "string",
  "default_billing_entity_id": "string",
  "default_product_tax_category": "STANDARD",
  "account_group_id": "string",
  "default_pricing_plan_subscription_settings": {
    "billing_entity_id": "string",
    "due_date_configuration": {
      "type": "PERIOD_AFTER_INVOICE_DATE",
      "period": {
        "type": "DAY",
        "value": 1
      }
    },
    "billing_period": {
      "type": "DAY",
      "value": 1
    },
    "billing_currency": "AED",
    "billing_time": "EXACT",
    "combine": true,
    "init_invoice_on_hold": true,
    "payment_acceptor_ids": [
      "string"
    ],
    "display_invoice_sub_lines_per_processing_only_customer": true,
    "show_original_customer_invoice_line": true,
    "replicate_meter_data_ingest_to_parent": true,
    "initial_term": {
      "type": "DAY",
      "value": 1
    },
    "renewal_term": {
      "type": "DAY",
      "value": 1
    },
    "auto_renewal": true
  },
  "crm_integrations": {
    "hubspot": {
      "portal_id": "string"
    }
  },
  "branding": {
    "colors": {
      "primary": "string",
      "secondary": "string"
    },
    "logo": {
      "file_name": "string",
      "content_type": "string",
      "public_url": "string"
    },
    "emblem": {
      "file_name": "string",
      "content_type": "string",
      "public_url": "string"
    },
    "name": "string",
    "domain": "string"
  },
  "invoice_settings": {
    "invoice_number_configuration": {
      "prefix": "string",
      "dynamic_prefix": [
        "string"
      ],
      "separator": "string",
      "increment_by": 1,
      "first_number": 1,
      "minimum_number_of_digits": 1,
      "reset_period": {
        "type": "string",
        "month": "JANUARY"
      }
    },
    "credit_invoice_number_configuration": {
      "prefix": "string",
      "dynamic_prefix": [
        "string"
      ],
      "separator": "string",
      "increment_by": 1,
      "first_number": 1,
      "minimum_number_of_digits": 1,
      "reset_period": {
        "type": "string",
        "month": "JANUARY"
      }
    },
    "self_billing_invoice_number_configuration": {
      "prefix": "string",
      "dynamic_prefix": [
        "string"
      ],
      "separator": "string",
      "increment_by": 1,
      "first_number": 1,
      "minimum_number_of_digits": 1,
      "reset_period": {
        "type": "string",
        "month": "JANUARY"
      }
    },
    "self_billing_credit_invoice_number_configuration": {
      "prefix": "string",
      "dynamic_prefix": [
        "string"
      ],
      "separator": "string",
      "increment_by": 1,
      "first_number": 1,
      "minimum_number_of_digits": 1,
      "reset_period": {
        "type": "string",
        "month": "JANUARY"
      }
    },
    "send_by_email": {
      "trigger_type": "MANUAL"
    },
    "export_to_erp": {
      "trigger_type": "MANUAL"
    },
    "invoice_date_determination_type": "AT_END_OF_BILLING_PERIOD",
    "invoice_grace_period": {
      "type": "string",
      "configuration": {
        "value": 1,
        "type": "string"
      }
    },
    "invoice_extra_open_period": {
      "value": 1,
      "type": "string"
    },
    "footnote": "string",
    "add_zero_meter_value_invoice_lines": true
  },
  "reporting_currency": "AED",
  "default_pricing_currency": "AED",
  "quote_settings": {
    "quote_pdf_configuration": {
      "display_customer_details": true,
      "display_billing_entity_details": true
    }
  },
  "rounding_settings": [
    {
      "rounding_target": "INVOICE",
      "rounding_mode": "DEFAULT"
    }
  ],
  "reprocessing_settings": {
    "default_delay": {
      "type": "SECOND",
      "value": 1
    }
  },
  "processing_settings": {
    "put_after_invoice_final_on_next_invoice": true
  },
  "default_portal_url_settings": {
    "customer": {
      "expiry_period": {
        "type": "DAY",
        "value": 1
      }
    }
  }
}

Requires the PLATFORM.DEFAULT_SETTINGS.EDIT, PRICING_PLAN_SUBSCRIPTION.DEFAULT_SETTINGS.EDIT, BRANDING.UPDATE or INVOICE.DEFAULT_SETTINGS.EDIT permission. Each field you set requires its own permission: reference, description, default_product_tax_category, crm_integrations, reporting_currency, default_pricing_currency, airbyte_workspace_id, quote_settings, rounding_settings, default_portal_url_settings, reprocessing_settings and processing_settings require PLATFORM.DEFAULT_SETTINGS.EDIT; default_pricing_plan_subscription_settings and default_billing_entity_id require PRICING_PLAN_SUBSCRIPTION.DEFAULT_SETTINGS.EDIT; branding requires BRANDING.UPDATE; invoice_settings requires INVOICE.DEFAULT_SETTINGS.EDIT.

Authentication

X-API-KEYstring

API Key authentication via header

AuthorizationBearer

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

Path parameters

versionstringRequiredDefaults to 1

version

resourceIdstringRequiredDefaults to

The ID of the resource to be requested.

Request

This endpoint expects an object.

referencestringOptionalformat: "^\S+$"0-256 characters

statusstring or nullOptional

timezonestring or nullOptional

descriptionstring or nullOptionalformat: "^[a-zA-Z0-9_\-\s+]*"0-256 characters

entity_idstring or nullOptional

The resource ID of the entity.

default_billing_entity_idstring or nullOptional

The resource ID of the billing entity.

default_product_tax_categoryenumOptional

The default tax category that will be applied to the product.

Allowed values:

account_group_idstringOptional

default_pricing_plan_subscription_settingsobjectOptional

The default configuration when creating a pricing plan subscription.

crm_integrationsobjectOptional

The associated crm integrations

brandingobjectOptional

Custom branding for the platform, the logo & colors can be set

invoice_settingsobjectOptional

The settings of the invoice

reporting_currencyenumOptional

currency for reporting on platform level

default_pricing_currencyenumOptional

initial/default currency when creating pricingPlanVersions

quote_settingsobjectOptional

The settings of the quote

rounding_settingslist of objects or nullOptional

Allow platforms to configure rounding behavior for different kinds of objects.

reprocessing_settingsobjectOptional

Settings for reprocessing

processing_settingsobjectOptional

Settings for processing

default_portal_url_settingsobjectOptional

The settings related with portal

Response

object_typestring or nullOptionalRead-only

created_atstring or nullOptionalRead-only

idstring or nullOptionalRead-only