wp-multisite-waas/inc/api/schemas/membership-create.php

<?php
/**
 * Schema for membership@create.
 *
 * @package WP_Ultimo\API\Schemas
 * @since 2.0.11
 */

// Exit if accessed directly
defined('ABSPATH') || exit;

use WP_Ultimo\Database\Memberships\Membership_Status;

/**
 * Schema for membership@create.
 *
 * @since 2.0.11
 * @internal last-generated in 2022-12
 * @generated class generated by our build scripts, do not change!
 *
 * @since 2.0.11
 */
return [
	'customer_id'                 => [
		'description' => __('The ID of the customer attached to this membership.', 'wp-multisite-waas'),
		'type'        => 'integer',
		'required'    => true,
	],
	'user_id'                     => [
		'description' => __('The user ID attached to this membership.', 'wp-multisite-waas'),
		'type'        => 'integer',
		'required'    => false,
	],
	'plan_id'                     => [
		'description' => __('The plan ID associated with the membership.', 'wp-multisite-waas'),
		'type'        => 'integer',
		'required'    => true,
	],
	'addon_products'              => [
		'description' => __('Additional products related to this membership. Services, Packages or other types of products.', 'wp-multisite-waas'),
		'type'        => 'mixed',
		'required'    => false,
	],
	'currency'                    => [
		'description' => __("The currency that this membership. It's a 3-letter code. E.g. 'USD'.", 'wp-multisite-waas'),
		'type'        => 'string',
		'required'    => false,
	],
	'duration'                    => [
		'description' => __('The interval period between a charge. Only the interval amount, the unit will be defined in another property.', 'wp-multisite-waas'),
		'type'        => 'integer',
		'required'    => false,
	],
	'duration_unit'               => [
		'description' => __("The duration amount type. Can be 'day', 'week', 'month' or 'year'.", 'wp-multisite-waas'),
		'type'        => 'string',
		'required'    => false,
		'enum'        => [
			'day',
			'month',
			'week',
			'year',
		],
	],
	'amount'                      => [
		'description' => __('The product amount.', 'wp-multisite-waas'),
		'type'        => 'integer',
		'required'    => false,
	],
	'initial_amount'              => [
		'description' => __('The initial amount charged for this membership, including the setup fee.', 'wp-multisite-waas'),
		'type'        => 'integer',
		'required'    => false,
	],
	'date_created'                => [
		'description' => __('Date of creation of this membership.', 'wp-multisite-waas'),
		'type'        => 'string',
		'required'    => false,
	],
	'date_activated'              => [
		'description' => __('Date when this membership was activated.', 'wp-multisite-waas'),
		'type'        => 'string',
		'required'    => false,
	],
	'date_trial_end'              => [
		'description' => __('Date when the trial period ends, if this membership has or had a trial period.', 'wp-multisite-waas'),
		'type'        => 'string',
		'required'    => false,
	],
	'date_renewed'                => [
		'description' => __('Date when the membership was cancelled.', 'wp-multisite-waas'),
		'type'        => 'string',
		'required'    => false,
	],
	'date_cancellation'           => [
		'description' => __('Date when the membership was cancelled.', 'wp-multisite-waas'),
		'type'        => 'string',
		'required'    => false,
	],
	'date_expiration'             => [
		'description' => __('Date when the membership will expiry.', 'wp-multisite-waas'),
		'type'        => 'string',
		'required'    => false,
	],
	'date_payment_plan_completed' => [
		'description' => __('Change of the payment completion for the plan value.', 'wp-multisite-waas'),
		'type'        => 'string',
		'required'    => false,
	],
	'auto_renew'                  => [
		'description' => __('If this membership should auto-renewal.', 'wp-multisite-waas'),
		'type'        => 'boolean',
		'required'    => false,
	],
	'times_billed'                => [
		'description' => __('Amount of times this membership got billed.', 'wp-multisite-waas'),
		'type'        => 'integer',
		'required'    => false,
	],
	'billing_cycles'              => [
		'description' => __('Maximum times we should charge this membership.', 'wp-multisite-waas'),
		'type'        => 'integer',
		'required'    => false,
	],
	'status'                      => [
		'description' => __("The membership status. Can be 'pending', 'active', 'on-hold', 'expired', 'cancelled' or other values added by third-party add-ons.", 'wp-multisite-waas'),
		'type'        => 'string',
		'required'    => false,
		'enum'        => Membership_Status::get_allowed_list(),
	],
	'gateway_customer_id'         => [
		'description' => __('The ID of the customer on the payment gateway database.', 'wp-multisite-waas'),
		'type'        => 'integer',
		'required'    => false,
	],
	'gateway_subscription_id'     => [
		'description' => __('The ID of the subscription on the payment gateway database.', 'wp-multisite-waas'),
		'type'        => 'string',
		'required'    => false,
	],
	'gateway'                     => [
		'description' => __('ID of the gateway being used on this subscription.', 'wp-multisite-waas'),
		'type'        => 'string',
		'required'    => false,
	],
	'signup_method'               => [
		'description' => __('Signup method used to create this membership.', 'wp-multisite-waas'),
		'type'        => 'string',
		'required'    => false,
	],
	'upgraded_from'               => [
		'description' => __('Plan that this membership upgraded from.', 'wp-multisite-waas'),
		'type'        => 'integer',
		'required'    => false,
	],
	'date_modified'               => [
		'description' => __('Date this membership was last modified.', 'wp-multisite-waas'),
		'type'        => 'string',
		'required'    => false,
	],
	'disabled'                    => [
		'description' => __('If this membership is a disabled one.', 'wp-multisite-waas'),
		'type'        => 'boolean',
		'required'    => false,
	],
	'recurring'                   => [
		'description' => __('If this membership is recurring (true), which means the customer paid a defined amount each period of time, or not recurring (false).', 'wp-multisite-waas'),
		'type'        => 'boolean',
		'required'    => false,
	],
	'migrated_from_id'            => [
		'description' => __('The ID of the original 1.X model that was used to generate this item on migration.', 'wp-multisite-waas'),
		'type'        => 'integer',
		'required'    => false,
	],
	'skip_validation'             => [
		'description' => __('Set true to have field information validation bypassed when saving this event.', 'wp-multisite-waas'),
		'type'        => 'boolean',
		'required'    => false,
	],
];