CompanySignup

A company signup the caller started. While PENDING it holds the details they typed and the products they picked, so the form can be restored instead of retyped when they come back from Checkout. Once COMPLETED it carries the company it produced.

type CompanySignup {
  company: Party
  companyName: String!
  companyType: CompanyTypesEnum!
  handle: String!
  id: ID!
  items: [CompanySignupItem!]!
  planName: String!
  status: CompanySignupStatusEnum!
}

Fields

CompanySignup.company ● Party object common

The company this signup produced. Null unless status is COMPLETED.

CompanySignup.companyName ● String! non-null scalar common

Display name the caller entered for the new company.

CompanySignup.companyType ● CompanyTypesEnum! non-null enum companies

Type the caller chose for the new company.

CompanySignup.handle ● String! non-null scalar common

URL handle reserved for the new company, and the handle it is created with, so it is safe to redirect on once status is COMPLETED.

CompanySignup.id ● ID! non-null scalar common

Identifier of the signup request.

CompanySignup.items ● [CompanySignupItem!]! non-null object billing

Every product this signup will subscribe to: the plan, plus any add-ons the caller picked. Replaced wholesale each time the caller resubmits.

CompanySignup.planName ● String! non-null scalar common

Stable name of the plan the caller last picked. The plan is only binding at completion, so it can still be changed.

CompanySignup.status ● CompanySignupStatusEnum! non-null enum billing

Whether the signup has finished. Poll this after returning from Checkout.

Returned By

companySignup query ● myPendingCompanySignup query