Overview

Classes

  • Syspay_Merchant_AstroPayBanksRequest
  • Syspay_Merchant_BillingAgreementCancellationRequest
  • Syspay_Merchant_BillingAgreementInfoRequest
  • Syspay_Merchant_BillingAgreementListRequest
  • Syspay_Merchant_BillingAgreementRequest
  • Syspay_Merchant_ChargebackInfoRequest
  • Syspay_Merchant_ChargebackListRequest
  • Syspay_Merchant_Client
  • Syspay_Merchant_ConfirmRequest
  • Syspay_Merchant_EMS
  • Syspay_Merchant_Entity
  • Syspay_Merchant_Entity_AstroPayBank
  • Syspay_Merchant_Entity_BillingAgreement
  • Syspay_Merchant_Entity_Chargeback
  • Syspay_Merchant_Entity_Creditcard
  • Syspay_Merchant_Entity_Customer
  • Syspay_Merchant_Entity_Eterminal
  • Syspay_Merchant_Entity_Payment
  • Syspay_Merchant_Entity_PaymentMethod
  • Syspay_Merchant_Entity_PaymentRecipient
  • Syspay_Merchant_Entity_Plan
  • Syspay_Merchant_Entity_Refund
  • Syspay_Merchant_Entity_Subscription
  • Syspay_Merchant_Entity_SubscriptionEvent
  • Syspay_Merchant_EterminalRequest
  • Syspay_Merchant_IpAddressesRequest
  • Syspay_Merchant_PaymentInfoRequest
  • Syspay_Merchant_PaymentListRequest
  • Syspay_Merchant_PaymentRequest
  • Syspay_Merchant_PlanInfoRequest
  • Syspay_Merchant_PlanRequest
  • Syspay_Merchant_PlanUpdateRequest
  • Syspay_Merchant_RebillRequest
  • Syspay_Merchant_Redirect
  • Syspay_Merchant_RefundInfoRequest
  • Syspay_Merchant_RefundListRequest
  • Syspay_Merchant_RefundRequest
  • Syspay_Merchant_Request
  • Syspay_Merchant_SubscriptionCancellationRequest
  • Syspay_Merchant_SubscriptionInfoRequest
  • Syspay_Merchant_SubscriptionRebillRequest
  • Syspay_Merchant_SubscriptionRequest
  • Syspay_Merchant_Utils
  • Syspay_Merchant_VoidRequest

Interfaces

  • Syspay_Merchant_Entity_ReturnedEntityInterface

Exceptions

  • Syspay_Merchant_EMSException
  • Syspay_Merchant_RedirectException
  • Syspay_Merchant_RequestException
  • Syspay_Merchant_UnexpectedResponseException
  • Overview
  • Class
  • Tree

Class Syspay_Merchant_Entity_Plan

A plan object

Syspay_Merchant_Entity
Extended by Syspay_Merchant_Entity_Plan implements Syspay_Merchant_Entity_ReturnedEntityInterface
Located at Syspay/SDK/Merchant/Entity/Plan.php
Methods summary
public static Syspay_Merchant_Entity_Plan
# buildFromResponse( stdClass $response )

Build a plan entity based on a json-decoded plan stdClass

Build a plan entity based on a json-decoded plan stdClass

Parameters

$response
The plan data

Returns

Syspay_Merchant_Entity_Plan
The plan object

Implementation of

Syspay_Merchant_Entity_ReturnedEntityInterface::buildFromResponse()
public integer
# getId( )

Gets the value of id.

Gets the value of id.

Returns

integer
integer
public Syspay_Merchant_Entity_Plan
# setId( integer $id )

Sets the value of id.

Sets the value of id.

Parameters

$id
the id

Returns

Syspay_Merchant_Entity_Plan
self
public DateTime
# getCreated( )

Gets the value of created.

Gets the value of created.

Returns

DateTime
DateTime
public Syspay_Merchant_Entity_Plan
# setCreated( DateTime $created )

Sets the value of created.

Sets the value of created.

Parameters

$created
the created

Returns

Syspay_Merchant_Entity_Plan
self
public string
# getStatus( )

Gets the value of status.

Gets the value of status.

Returns

string
string
public Syspay_Merchant_Entity_Plan
# setStatus( string $status )

Sets the value of status.

Sets the value of status.

Parameters

$status
the status

Returns

Syspay_Merchant_Entity_Plan
self
public string
# getName( )

Gets the value of name.

Gets the value of name.

Returns

string
string
public Syspay_Merchant_Entity_Plan
# setName( string $name )

Sets the value of name.

Sets the value of name.

Parameters

$name
the name

Returns

Syspay_Merchant_Entity_Plan
self
public string
# getDescription( )

Gets the value of description.

Gets the value of description.

Returns

string
string
public Syspay_Merchant_Entity_Plan
# setDescription( string $description )

Sets the value of description.

Sets the value of description.

Parameters

$description
the description

Returns

Syspay_Merchant_Entity_Plan
self
public string
# getCurrency( )

Gets the value of currency.

Gets the value of currency.

Returns

string
string
public Syspay_Merchant_Entity_Plan
# setCurrency( string $currency )

Sets the value of currency.

Sets the value of currency.

Parameters

$currency
the currency

Returns

Syspay_Merchant_Entity_Plan
self
public integer
# getTrialAmount( )

Gets the value of trial_amount.

Gets the value of trial_amount.

Returns

integer
integer
public Syspay_Merchant_Entity_Plan
# setTrialAmount( integer $trial_amount )

Sets the value of trial_amount.

Sets the value of trial_amount.

Parameters

$trial_amount
the trial_amount

Returns

Syspay_Merchant_Entity_Plan
self
public integer
# getTrialPeriod( )

Gets the value of trial_period.

Gets the value of trial_period.

Returns

integer
integer
public Syspay_Merchant_Entity_Plan
# setTrialPeriod( integer $trial_period )

Sets the value of trial_period.

Sets the value of trial_period.

Parameters

$trial_period
the trial_period

Returns

Syspay_Merchant_Entity_Plan
self
public string
# getTrialPeriodUnit( )

Gets the value of trial_period_unit.

Gets the value of trial_period_unit.

Returns

string
string
public Syspay_Merchant_Entity_Plan
# setTrialPeriodUnit( string $trial_period_unit )

Sets the value of trial_period_unit.

Sets the value of trial_period_unit.

Parameters

$trial_period_unit
the trial_period_unit

Returns

Syspay_Merchant_Entity_Plan
self
public integer
# getTrialCycles( )

Gets the value of trial_cycles.

Gets the value of trial_cycles.

Returns

integer
integer
public Syspay_Merchant_Entity_Plan
# setTrialCycles( integer $trial_cycles )

Sets the value of trial_cycles.

Sets the value of trial_cycles.

Parameters

$trial_cycles
the trial_cycles

Returns

Syspay_Merchant_Entity_Plan
self
public integer
# getInitialAmount( )

Gets the value of initial_amount.

Gets the value of initial_amount.

Returns

integer
integer
public Syspay_Merchant_Entity_Plan
# setInitialAmount( integer $initial_amount )

Sets the value of initial_amount.

Sets the value of initial_amount.

Parameters

$initial_amount
the initial_amount

Returns

Syspay_Merchant_Entity_Plan
self
public integer
# getBillingAmount( )

Gets the value of billing_amount.

Gets the value of billing_amount.

Returns

integer
integer
public Syspay_Merchant_Entity_Plan
# setBillingAmount( integer $billing_amount )

Sets the value of billing_amount.

Sets the value of billing_amount.

Parameters

$billing_amount
the billing_amount

Returns

Syspay_Merchant_Entity_Plan
self
public integer
# getBillingPeriod( )

Gets the value of billing_period.

Gets the value of billing_period.

Returns

integer
integer
public Syspay_Merchant_Entity_Plan
# setBillingPeriod( integer $billing_period )

Sets the value of billing_period.

Sets the value of billing_period.

Parameters

$billing_period
the billing_period

Returns

Syspay_Merchant_Entity_Plan
self
public string
# getBillingPeriodUnit( )

Gets the value of billing_period_unit.

Gets the value of billing_period_unit.

Returns

string
string
public Syspay_Merchant_Entity_Plan
# setBillingPeriodUnit( string $billing_period_unit )

Sets the value of billing_period_unit.

Sets the value of billing_period_unit.

Parameters

$billing_period_unit
the billing_period_unit

Returns

Syspay_Merchant_Entity_Plan
self
public integer
# getBillingCycles( )

Gets the value of billing_cycles.

Gets the value of billing_cycles.

Returns

integer
integer
public Syspay_Merchant_Entity_Plan
# setBillingCycles( integer $billing_cycles )

Sets the value of billing_cycles.

Sets the value of billing_cycles.

Parameters

$billing_cycles
the billing_cycles

Returns

Syspay_Merchant_Entity_Plan
self
public integer
# getRetryMapId( )

Gets the value of retry_map_id.

Gets the value of retry_map_id.

Returns

integer
integer
public Syspay_Merchant_Entity_Plan
# setRetryMapId( integer $retry_map_id )

Sets the value of retry_map_id.

Sets the value of retry_map_id.

Parameters

$retry_map_id
the retry_map_id

Returns

Syspay_Merchant_Entity_Plan
self
public string
# getType( )

Gets the value of type.

Gets the value of type.

Returns

string
string

Overrides

Syspay_Merchant_Entity::getType()
public Syspay_Merchant_Entity_Plan
# setType( string $type )

Sets the value of type.

Sets the value of type.

Parameters

$type
the type

Returns

Syspay_Merchant_Entity_Plan
self
public integer
# getTotalAmount( )

Gets the value of total_amount.

Gets the value of total_amount.

Returns

integer
integer
public Syspay_Merchant_Entity_Plan
# setTotalAmount( integer $total_amount )

Sets the value of total_amount.

Sets the value of total_amount.

Parameters

$total_amount
the total_amount

Returns

Syspay_Merchant_Entity_Plan
self
public integer
# getDefaultCaptureDelay( )

Gets the value of $default_capture_delay.

Gets the value of $default_capture_delay.

Returns

integer
int
public Syspay_Merchant_Entity_Plan
# setDefaultCaptureDelay( integer $default_capture_delay )

Sets the value of $default_capture_delay.

Sets the value of $default_capture_delay.

Parameters

$default_capture_delay

Returns

Syspay_Merchant_Entity_Plan
self
Methods inherited from Syspay_Merchant_Entity
toArray()
Constants summary
string TYPE
#'plan'
string UNIT_MINUTE
#'minute'
string UNIT_HOUR
#'hour'
string UNIT_DAY
#'day'
string UNIT_WEEK
#'week'
string UNIT_MONTH
#'month'
string UNIT_YEAR
#'year'
string TYPE_SUBSCRIPTION
#'SUBSCRIPTION'
string TYPE_INSTALMENT
#'INSTALMENT'
Properties inherited from Syspay_Merchant_Entity
$raw
Syspay Merchant SDK API documentation generated by ApiGen 2.8.0