# Schemas

- [actor](/api/latest/schemas/actor)
- [addon](/api/latest/schemas/addon): Add-ons define features or top-ups that can be used to extend the functionality offered to the end user through their subscription's plan.
- [allowance](/api/latest/schemas/allowance): An allowance represents a specific usage limit (e.g., minutes, bytes, messages) the purchase of a product entitles a user to.
- [apiKey](/api/latest/schemas/apiKey)
- [authorizationServerMetadata](/api/latest/schemas/authorizationServerMetadata): OAuth 2.0 Authorization Server Metadata as defined by RFC 8414. Only the metadata that describes capabilities we actually implement is advertised. Fields for unimplemented features are deliberately omitted rather than populated with placeholders: - authorization_endpoint — we implement no redirect-based authorization endpoint. RFC 8414 section 2 permits omitting it when no supported grant type uses it. - registration_endpoint — dynamic client registration (RFC 7591) is not supported; clients are registered out of band. - revocation_endpoint / introspection_endpoint — access tokens are self-contained JWTs that cannot be revoked and do not need introspection. - scopes_supported — the scope space is project:{project_id}, so the set of valid values is per-application and cannot be enumerated here. - code_challenge_methods_supported — PKCE (RFC 7636) only applies to the authorization code grant, which we do not support.
- [connectSession](/api/latest/schemas/connectSession)
- [consentRequest](/api/latest/schemas/consentRequest)
- [coverage](/api/latest/schemas/coverage)
- [creditNote](/api/latest/schemas/creditNote): Credit notes adjust an invoice amount after it has been finalized. Used to issue credit or refunds.
- [deprecatedPortOutCredential](/api/latest/schemas/deprecatedPortOutCredential)
- [device](/api/latest/schemas/device): Devices are the phones or smartwatches that will be tied to a user’s plan.
- [deviceModel](/api/latest/schemas/deviceModel)
- [deviceModelBrands](/api/latest/schemas/deviceModelBrands)
- [error](/api/latest/schemas/error)
- [eSimProfile](/api/latest/schemas/eSimProfile)
- [invoice](/api/latest/schemas/invoice): Invoices describe the amount due to a user for a given subscription period, including any relevant taxes and fees.
- [jwk](/api/latest/schemas/jwk): A JSON Web Key represents a cryptographic key. The members of this object represent properties of the key, including its value, as defined by RFC 7517.
- [jwks](/api/latest/schemas/jwks): JSON Web Key Set (JWKS) is a JSON object that represents a set of JSON Web Keys (JWKs) as defined by RFC 7517.
- [metadata](/api/latest/schemas/metadata): A set of key-value pairs, to store metadata related to the resource.
- [metadataUpdate](/api/latest/schemas/metadataUpdate): A set of key-value pairs, to store metadata related to the resource.
- [networkAvailability](/api/latest/schemas/networkAvailability)
- [networkAvailabilityTileset](/api/latest/schemas/networkAvailabilityTileset)
- [organization](/api/latest/schemas/organization)
- [payment](/api/latest/schemas/payment): Payments describe the amount charged for an order or subscription using a given payment method.
- [paymentMethod](/api/latest/schemas/paymentMethod): Payment methods are used to process payments for subscriptions and orders.
- [period](/api/latest/schemas/period)
- [plan](/api/latest/schemas/plan): Plans define the network options and parameters offered to the end user, e.g. 'Unlimited data, voice & text'. Plan allowances (data, sms, voice) and limits are configurable, and Gigs will work with you to find the best balance for your users.
- [planDocument](/api/latest/schemas/planDocument)
- [porting](/api/latest/schemas/porting): Porting is required when a user wants to keep their phone number when changing their subscription. There are multiple steps involved between the user, their previous carrier, and the new subscriber
- [portOut](/api/latest/schemas/portOut): Port out is required when a user wants to keep their number when cancelling their subscription. There are multiple steps involved between the user, the current carrier, and the new carrier.
- [portOutCredentials](/api/latest/schemas/portOutCredentials): Port out credentials issued by network provider and used for the porting process at the target provider.
- [price](/api/latest/schemas/price)
- [project](/api/latest/schemas/project): A project is where all of the user, subscription, plan, device, and SIM information lives.
- [projectCredentials](/api/latest/schemas/projectCredentials)
- [propertyErrorDetailError](/api/latest/schemas/propertyErrorDetailError)
- [quote](/api/latest/schemas/quote): Quotes provide a preview of the invoices, including taxes and fees, that will occur when creating a subscription or add-on.
- [serviceProvider](/api/latest/schemas/serviceProvider)
- [sim](/api/latest/schemas/sim): A SIM is a unique card that identifies itself to a specific mobile network and provides voice, text, and data connectivity to a user’s device. There are two types of available SIMs: eSIM and pSIM. eSIMs can be activated and installed instantly on any eSIM compatible device, pSIMs (physical SIMs) must be provided to the user or installed into the device beforehand.
- [simCredentials](/api/latest/schemas/simCredentials)
- [subscription](/api/latest/schemas/subscription): Subscriptions are tied to a user and are created once a user has a plan and SIM. This allows connectivity for their device and SIM.
- [subscriptionAddon](/api/latest/schemas/subscriptionAddon): Subscription add-ons are features or top-ups that extend the functionality offered to the end user through their subscription, as defined by the associated add-on.
- [subscriptionChange](/api/latest/schemas/subscriptionChange): Any change to a user’s subscription, such as swapping a SIM, or upgrading or downgrading a subscription.
- [subscriptionGroup](/api/latest/schemas/subscriptionGroup): A subscription group represents a collection of subscriptions.
- [usageBalance](/api/latest/schemas/usageBalance): A usage balance represents the amount of usage consumed from an Allowance for a given Subscription in a certain Period.
- [usageBalanceSource](/api/latest/schemas/usageBalanceSource): The entity providing the Allowance to the Subscription.
- [usageRecord](/api/latest/schemas/usageRecord): Usage records track subscription usage for users. This includes data, voice, and text usage. Note that there is a delay in usage data that varies between carriers.
- [user](/api/latest/schemas/user): Users are end consumers of subscriptions. Users can have multiple devices, SIMs, and subscriptions.
- [userAddress](/api/latest/schemas/userAddress)
- [virtualNumber](/api/latest/schemas/virtualNumber): Virtual numbers are additional numbers that can be added for a user. Any calls made or texts sent to an active virtual number will be received by the primary number of the subscription. Note that this is an experimental feature that is only available in select projects.
- [voucher](/api/latest/schemas/voucher): Vouchers describe the discounts to apply to quotes and subscriptions.
