Project

A project is where all of the user, subscription, plan, device, and SIM information lives.

  • Name
    object
    Type
    string
    Description

    Type of object is always project.

    Allowed values: project 
  • Name
    id
    Type
    string
    Description

    Globally unique identifier for the project.

    Example: "gigs"
  • Name
    billing
    Type
    nullable object
    Description
    Configuration parameters for the project use of billing. Present when the Billing API is enabled.
  • Name
    createdAt
    Type
    string
    Description

    Time when the project was created.

    Example: "2021-01-21T19:32:13Z"
  • Name
    image
    Type
    nullable string
    Status
    PREVIEW
    Description

    Small-resolution project icon with an aspect ratio of 1:1.

    Example: "https://a.gigscdn.net/p/gigs/icon.png"
  • Name
    locales
    Type
    array
    Description

    List of supported locales represented as IETF language tags, ordered by preference.

    Example: ["en-US"]
  • Name
    name
    Type
    string
    Description

    A human-readable name for the project.

    Example: "Gigs Connect"
  • Name
    organization
    Type
    Organization
    Description
  • Name
    payments
    Type
    nullable object
    Description
    Configuration parameters for the project use of payments.
    • Name
      currency
      Type
      string
      Description

      Three-letter ISO 4217 currency code representing the currency of the project. Must be a supported currency.

      Example: "USD"
    • Name
      mode
      Type
      string
      Status
      DEPRECATED
      Description

      This property is deprecated and will be removed in the future. Use the root-level field type instead.

      The mode in which the payments operate.

      Allowed values: live test 
  • Name
    subscriptionOwner
    Type
    string
    Description

    Indicates which entity will be registered as the owner of the subscription with the providers. When company is selected the legal address associated with the project will be used for the registration.

    Allowed values: user company 
  • Name
    support
    Type
    nullable object
    Description
    Contact details for consumer support requests regarding the project.
    • Name
      email
      Type
      nullable string
      Description

      A publicly available email address for consumer support requests regarding the project.

      Example: "support@gigs.com"
    • Name
      phoneNumber
      Type
      nullable string
      Description

      A publicly available phone number in E.164 format for consumer support requests regarding the project.

      Example: "+12345678900"
  • Name
    tax
    Type
    nullable object
    Description
    Tax configuration for the project.
    • Name
      country
      Type
      nullable string
      Description

      The ISO 3166-1 alpha-2 country code for tax purposes. This will be used as the fallback country for tax calculations when a more specific country cannot be determined (e.g. user address).

      Example: "US"
  • Name
    type
    Type
    string
    Description

    Indicates whether this is a live or test project. In live projects, subscriptions are invoiced to your organization, and any payments and taxes are real. The type cannot be changed after project creation.

    Example: "live"
    Allowed values: live test 

Example

{
  "object": "project",
  "id": "gigs",
  "billing": {
    "advanceInvoicingDays": 7,
    "invoiceGracePeriodDays": 3,
    "invoiceOverdueDays": 3,
    "invoiceOverduePeriodDays": 1,
    "invoiceOverdueAction": "end",
    "currency": "USD",
    "restrictBehavior": null,
    "restoreBehavior": null,
    "paymentBehavior": "manual",
    "taxBehavior": "exclusive",
    "recoveryFeePercentage": 10,
    "recoveryFeeAmount": {
      "amount": 150,
      "currency": "USD"
    }
  },
  "consent": {
    "deliveryMethods": [
      "emailLink"
    ]
  },
  "createdAt": "2021-01-21T19:32:13.0Z",
  "image": "https://a.gigscdn.net/p/gigs/icon.png",
  "legal": {
    "name": "Gigs Inc.",
    "city": "New York City",
    "country": "US",
    "line1": "129 West 81st Street",
    "line2": "Apartment 5",
    "postalCode": "10024",
    "state": "NY"
  },
  "locales": [
    "en-US"
  ],
  "name": "Gigs Connect",
  "organization": {
    "object": "organization",
    "id": "org_0SNlurA04kOdemVEMVZQBF",
    "createdAt": "2021-02-01T13:21:30.0Z",
    "name": "Gigs"
  },
  "payments": {
    "currency": "USD",
    "mode": "live"
  },
  "subscriptionOwner": "user",
  "support": {
    "email": "support@gigs.com",
    "phoneNumber": "+12345678900"
  },
  "tax": {
    "country": "US"
  },
  "type": "live"
}