Skip to main content
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>'
{
  "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

​
id
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"

​
Response

​
200

​
TariffId
integer
ID of the tariff linked to this record.
​
TariffName
string
Tariff name.
​
ProductId
integer
ID of the product linked to this record.
​
ProductName
string
Product name.
​
ProductPrice
number
Product price.
​
ProductCurrencyCode
string
Product currency code.
​
Price
number
Signup product price override.
​
Refundable
boolean
Whether the signup product is refundable.
​
InvoiceDuringOnlineCheckout
boolean
Whether invoice during online checkout is enabled.
​
Id
integer
Unique record identifier.
​
UniqueId
string
UUID of the record.
​
CreatedOn
string
Date and time the record was created (ISO 8601).
​
UpdatedOn
string
Date and time the record was last updated (ISO 8601).
​
UpdatedBy
string
Email of the user who last updated this record.
​
IsNew
boolean
Whether the record was recently created.
​
SystemId
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
}