An application is the entity selling a good or service to others.
An application can be thought of as a company, though separate applications can also be created for individual lines of business within one company.
Each application operates independently within Revenue HQ, even if the cash is ultimately deposited into the same bank account. Applications have no knowledge of each other, and no data can be shared between applications.
All applications will have a public landing page and account management service made available on the domain myrevhq.com. When creating an application, you will supply your requested subdomain (which must be unique). Your public instance will then be available at subdomain.myrevhq.com.
You will also be able to supply an optional custom domain under your control, whose DNS you will point back to our servers (e.g., example.com).
All application-specific API calls (i.e., begin with /applications/applicationID) will also be available against the subdomain and the optional custom domain at the /api path. For example, retrieving an application's API tokens can be done by making a GET request to subdomain.myrevhq.com/api/api-tokens or example.com/api/api-tokens.
Attributes:
| Name | Type | Description |
|---|---|---|
| id | string | V7 UUID generated when the application is created. |
| entitlements | array | Array of Entitlements that the application offers. |
| stripe_id | string | The Stripe ID of the application. This is used to manage billing, subscriptions, and payouts. |
| has_plans | boolean | If the application has established at least one plan. |
| charges_enabled | boolean | If the application has configured the payment processor such that it is authorized to process charges. |
| payouts_enabled | boolean | If the application has configured the payment processor such that payouts are authorized to its bank account. |
| requirements | object | An object outlining outstanding and future requirements imposed by the payment processor. This object has the following keys:currently_due array of strings of requirements currently due.current_due_dateUnix timestamp of when these requirements are due. If not addressed by the due date, the application might be disabled.eventually_due array of strings of requirements that will eventually be due. If not handled, they will transition to currently_due.past_due array of strings of requirements that are past due (these may or many not have disabled the application for non-compliance). |
| owner_id | string | The id of the user who owns the application. |
| users | array | Array of all Users who are authorized to manage the application. The scopes attribute is populated in relation to this application. This field is only returned for the following scopes: owner and admin:full. |
| scopes | array | Array of Scopes associated with the authenticated user. This field is only populated if the request is made by a user (and not an application API token). |
| api_version | integer | The major API version that will be processed by default (can be overwritten by the REVHQ-Version header). |
| name | string | The name of the application. |
| subdomain | string | The unique subdomain under which landing pages will be available. If the subdomain is greatest-company, then landing pages will be available at greatest-company.myrevhq.com. |
| custom_domain | string | The custom domain under which landing pages will be available. If the custom domain is example.com, then landing pages will be available at example.com. |
| descriptor | string | The complete descriptor that appears on account statements. |
| post_signup_redirect | uri | Where to redirect an account after successful signup. The query parameter rhq_account will be appended to this URL. This short-lived token can then be verified via API to get a full Account object. This will allow your application to create its own internal object that is associated with the Revenue HQ account. |
| terms_of_service | uri | The URL of the terms of service for the application. This will be linked to directly from the signup page. |
| privacy_policy | uri | The URL of the privacy policy for the application. This will be linked to directly from the signup page. |
| cancel_location | string | Descriptive location of where to cancel a subscription from within your web application. This will be referenced in the signup disclaimer, with a default value of "Account Settings". |
| gtm_container_id | string | The identifier of the Google Tag Manager container that should be embedded in all landing pages. This generally takes the form of GTM-XXXX. |
| timezone | string | The timezone for the application. This will impact things like daily reports (how many people signed up yesterday) as well as provide default conversions when interacting with offers via the web console. |
| additional_sitemaps | array | Array of strings of all external sitemaps. These will be included in the main sitemap index located at /sitemaps/index.xml (which is embedded in robots.txt by default). |
| reply_to_email | string | The email address that transaction emails (e.g., refund notifications) will be set in the "Reply-To" header. Defaults to [email protected]. |
| reply_to_name | string | The human-readable name associated with the "Reply-To" email header. Defaults to your application name. |
| created_at | integer | Unix timestamp of when the application was created (in seconds since the Unix epoch). |
| updated_at | integer | Unix timestamp of when the application was last updated (in seconds since the Unix epoch). |