Get one TariffSignupProduct

GET

api

billing

tariffsignupproducts

{id}

Get one TariffSignupProduct

curl --request GET \
  --url https://spaces.nexudus.com/api/billing/tariffsignupproducts/{id} \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/billing/tariffsignupproducts/{id}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/billing/tariffsignupproducts/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "TariffId": 123,
  "TariffName": "<string>",
  "ProductId": 123,
  "ProductName": "<string>",
  "ProductPrice": 123,
  "ProductCurrencyCode": "<string>",
  "Price": 123,
  "Refundable": true,
  "InvoiceDuringOnlineCheckout": true,
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

A TariffSignupProduct links a product to a pricing plan (tariff) as a one-time sign-up charge. Products linked this way are automatically added to a customer’s first invoice when they join the plan.

Authentication

This endpoint requires OAuth2 authentication. Include a valid bearer token in the Authorization header. The authenticated user must be a full unrestricted administrator or have the TariffSignupProduct-Read role.

Path Parameters

integer

required

The Id of the TariffSignupProduct record to retrieve.

Code Examples

curl -X GET \
  "https://spaces.nexudus.com/api/billing/tariffsignupproducts/87654321" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/billing/tariffsignupproducts/87654321',
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const record = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/billing/tariffsignupproducts/87654321',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

record = response.json()

Response

200

integer

ID of the tariff linked to this record.

string

Tariff name.

integer

ID of the product linked to this record.

string

Product name.

number

Product price.

string

Product currency code.

number

Signup product price override.

boolean

Whether the signup product is refundable.

boolean

Whether invoice during online checkout is enabled.

integer

Unique record identifier.

string

UUID of the record.

string

Date and time the record was created (ISO 8601).

string

Date and time the record was last updated (ISO 8601).

string

Email of the user who last updated this record.

boolean

Whether the record was recently created.

string

External system identifier.

Example Response

{
  "TariffId": 0,
  "TariffName": null,
  "ProductId": 0,
  "ProductName": null,
  "ProductPrice": 0,
  "ProductCurrencyCode": null,
  "Price": null,
  "Refundable": false,
  "InvoiceDuringOnlineCheckout": false,
  "Id": 87654321,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "CreatedOn": "2025-01-10T08:00:00Z",
  "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "UpdatedBy": "admin@example.com",
  "IsNew": false,
  "SystemId": null,
  "ToStringText": "TariffSignupProduct Example",
  "LocalizationDetails": null,
  "CustomFields": null
}

Get multiple TariffSignupProductsRetrieve multiple TariffSignupProduct records by their Ids in a single request.

Get one TariffSignupProduct

curl --request GET \
  --url https://spaces.nexudus.com/api/billing/tariffsignupproducts/{id} \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/billing/tariffsignupproducts/{id}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/billing/tariffsignupproducts/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "TariffId": 123,
  "TariffName": "<string>",
  "ProductId": 123,
  "ProductName": "<string>",
  "ProductPrice": 123,
  "ProductCurrencyCode": "<string>",
  "Price": 123,
  "Refundable": true,
  "InvoiceDuringOnlineCheckout": true,
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Path Parameters

Code Examples

Response

200

​Authentication

​Path Parameters

​Code Examples

​Response

​200

Authentication

Path Parameters

Code Examples

Response

200