Plan
@TODO DESCRIBE ME




POST as x-www-form-urlencoded:

https://joy.classapp.co/graphql?access_token=YOUR_TOKEN_HERE&client_id=YOUR_CLIENT_ID


Plan

ParamsDescription
idThe ID of an object
dbIdIdentifies the primary key from the database.
namePlan name
descriptionPlan description
recurrenceIntervalRecurrence interval
chargeExpirationDaycharge's expiration day
sendMessageDayDay of the month or week(1=Sundsay and 7=Saturday) message should be sent
installmentsDate limit of the recurrence
trialDaysnumber of days of trial before start charging
statusPlan status
invisibleWhether the plan is invisible
amount
organizationOrganization the plan belongs to
productsProduct related to the plan
contractsContracts using this plan
logsLogs
createdAn ISO-8601 encoded UTC date string of when record was created
modifiedAn ISO-8601 encoded UTC date string of when record was updated
deletedAn ISO-8601 encoded UTC date string of when record was deleted
keyRandom ID to differentiate from others
selectedHelper field for clients
highlightedHelper field for clients
expandedHelper field for clients
loadedHelper field for clients
loadingHelper field for clients

CreatePlanInput

ArgumentsTypeDescription
organizationId
Not Null
organization ID
products
LIST
PlanProductInputFields
name
Not Null
Plan name
description
String
SCALAR
Plan description
recurrenceInterval
Not Null
Recurrence interval
chargeExpirationDay
Not Null
charge's expiration day
sendMessageDay
Not Null
Day of the month or week(1=Sundsay and 7=Saturday) message should be sent
installments
Not Null
Date limit of the recurrence
trialDays
String
SCALAR
number of days of trial before start charging
status
Not Null
Plan status
invisible
Boolean
SCALAR
Whether the plan is invisible
clientMutationId
String
SCALAR

UpdatePlanInput

ArgumentsTypeDescription
id
Not Null
Plan ID
products
LIST
PlanProductInputFields
name
Not Null
Plan name
description
String
SCALAR
Plan description
recurrenceInterval
Not Null
Recurrence interval
chargeExpirationDay
Not Null
charge's expiration day
sendMessageDay
Not Null
Day of the month or week(1=Sundsay and 7=Saturday) message should be sent
installments
Not Null
Date limit of the recurrence
trialDays
String
SCALAR
number of days of trial before start charging
status
Not Null
Plan status
invisible
Boolean
SCALAR
Whether the plan is invisible
clientMutationId
String
SCALAR

DeletePlanInput

ArgumentsTypeDescription
id
Not Null
Plan ID
clientMutationId
String
SCALAR