Class WC_Braintree_Subscription

WC_Order

WC_Braintree_Subscription

Package: Braintree\Classes\Subscriptions
Since: 3.0.0
Located at subscriptions/class-wc-braintree-subscription.php

Methods summary

`public`	# `__construct( $order = 0 )`
`public`	# `get_type( )`
`public`	# `get_order( $id = 0 )`
`public`	# `wc_braintree_get_post( )`
`public`	# `get_formatted_line_subtotal( $item, $tax_display = '' )`
`public`	# `update_status( $new_status, $note = '', $manual = false )` Update the Subscription status. Update the Subscription status. See WC_Abstract_Order::update_status()
`public`	# `save( )`
`public`	# `status_transition( )`
`public`	# `payment_complete( $transaction_id = '' )`
`public`	# `get_valid_statuses( )`
`public`	# `get_order_item_totals( $tax_display = '' )`
`protected`	# `add_order_item_totals_subtotal_row( array & $total_rows, string $tax_display )` Add total row for subtotal. Add total row for subtotal. Parameters `$total_rows` `$tax_display`
`protected`	# `add_order_item_totals_total_row( & $total_rows, $tax_display )`
`public`	# `get_formatted_order_total( $tax_display = '', $display_refunded = true )`
`public boolean`	# `never_expires( )` Does the subscription have a length or does it never expire. Does the subscription have a length or does it never expire. Returns boolean
`public`	# `get_length( )`
`public`	# `get_billing_interval( )`
`public`	# `get_period( )`
`public boolean`	# `has_trial( )` Return true if the subscription has a trial period. Return true if the subscription has a trial period. Returns boolean
`public`	# `get_trial_period( )`
`public`	# `get_trial_length( )`
`public`	# `get_timezone( )`
`public`	# `get_date_key( $type )`
`public DateTime`	# `get_date( $type )` Return the datetime object for the specified date. All dates are returned in UTC. Return the datetime object for the specified date. All dates are returned in UTC. Returns DateTime
`public`	# `update_date( string $type, mixed $date )` Parameters `$type` `$date` $date
`public`	# `get_descriptor( unknown $type )` Return the descriptor for the type provided. Valid types are name, phone, url Return the descriptor for the type provided. Valid types are name, phone, url Parameters `$type`
`public`	# `has_descriptors( )` Return true if descriptors have been configured for the subscription. Return true if descriptors have been configured for the subscription.
`public`	# `update_payment_method_title( $title )`
`public`	# `update_payment_method_token( $token = '' )`
`public`	# `set_created( boolean $value )` Parameters `$value` $bool
`public`	# `is_created( )` Return true if the subscription has been created within Braintree. Return true if the subscription has been created within Braintree.
`public`	# `get_formatted_total( )`
`public`	# `get_formatted_date( string $type, string $format = null )` Return a formatted date string using the timezone that the subscription was created in. Return a formatted date string using the timezone that the subscription was created in. Parameters `$type` `$format`
`public`	# `has_child_orders( )` return true if child orders have been processed for the subscription. return true if child orders have been processed for the subscription.
`public`	# `get_payment_method_to_display( )`
`public`	# `get_view_subscription_url( )`
`public boolean`	# `last_day_of_month( )` Return true if the subscription starts on the last day of the month. Return true if the subscription starts on the last day of the month. Returns boolean
`public`	# `sync_dates( )` Sync the subscription's dates before creating in Braintree. This will allow for accurate date calculations. For example, when a subscription is created by the admin, a customer may not pay for it for several days. The start date, etc need to be re-calculated. Sync the subscription's dates before creating in Braintree. This will allow for accurate date calculations. For example, when a subscription is created by the admin, a customer may not pay for it for several days. The start date, etc need to be re-calculated.
`public`	# `get_num_of_billing_cycles( )` Return the number of billing cycles a subsciption has. Return the number of billing cycles a subsciption has.
`public`	# `get_checkout_payment_url( $on_checkout = false )`
`public`	# `can_be_updated_to( string $status )` Return if the subscription's status can be update to the provided status. Return if the subscription's status can be update to the provided status. Parameters `$status`
`private`	# `set_date( $prop, $value )`
`public`	# `set_merchant_account_id( $value )`
`public`	# `set_start_date( $value )`
`public`	# `set_next_payment_date( $value )`
`public`	# `set_previous_payment_date( $value )`
`public`	# `set_trial_end_date( $value )`
`public`	# `set_end_date( $value )`
`public`	# `set_subscription_trial_length( $value )`
`public`	# `set_subscription_trial_period( $value )`
`public`	# `set_first_payment_date( $value )`
`public`	# `set_braintree_plan( $value )`
`public`	# `set_subscription_period( $value )`
`public`	# `set_subscription_period_interval( $value )`
`public`	# `set_subscription_length( $value )`
`public`	# `set_created_in_braintree( $value )`
`public`	# `set_recurring_cart_key( $value )`
`public`	# `get_merchant_account_id( )` Getters Getters
`public`	# `get_start_date( )`
`public`	# `get_trial_end_date( )`
`public`	# `get_end_date( )`
`public`	# `get_subscription_trial_length( )`
`public`	# `get_subscription_trial_period( )`
`public`	# `get_first_payment_date( )`
`public`	# `get_next_payment_date( )`
`public`	# `get_previous_payment_date( )`
`public`	# `get_braintree_plan( )`
`public`	# `get_subscription_period( )`
`public`	# `get_subscription_period_interval( )`
`public`	# `get_subscription_length( )`
`public`	# `get_created_in_braintree( )`
`public`	# `get_recurring_cart_key( )`
`public`	# `get_cancel_subscription_url( )`

Properties summary

`protected array`	`$extra_data`	# `array( 'merchant_account_id' => '', 'subscription_trial_length' => '', 'subscription_trial_period' => 'day', 'start_date' => '', 'trial_end_date' => '', 'first_payment_date' => '', 'next_payment_date' => '', 'end_date' => '', 'previous_payment_date' => '', 'braintree_plan' => '', 'subscription_period' => 'month', 'subscription_period_interval' => '', 'subscription_length' => '', 'created_in_braintree' => false, 'recurring_cart_key' => '', )`
`protected string`	`$data_store_name`	# `'braintree_subscription'`
`public WC_Order`	`$order`	#

Namespaces

Classes

Traits

Functions

Class WC_Braintree_Subscription

Methods summary

See

Parameters

Returns

Returns

Returns

Parameters

Parameters

Parameters

Parameters

Returns

Parameters

Properties summary